Skip to content

Commit 697128c

Browse files
committed
Merge branch 'main' of github.com:devforth/adminforth
2 parents 6bb5839 + 225212b commit 697128c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+979
-149
lines changed

Changelog.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,28 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [v1.5.11] - next
8+
## [v1.5.12] - next
9+
10+
### Fixed
11+
- beforeEnter navigation guard on login route to check user already logged in postponed onMounted and created undefined rest request e.g. on signupPage (with race condition). Now it is called in component
12+
- AFCL progress bar component
13+
- sorting for virtual columns is disabled by default now, and sorting icon appers only if user sets column.sortable = true, in this case user has to implement sorting in `list.beforeDatasourceRequest` hook
14+
15+
### Improved
16+
- add pluralization support exposed `tr` function
17+
18+
19+
## [v1.5.11] - 2025-01-07
20+
21+
Major AFCL update https://adminforth.dev/docs/tutorial/Customization/afcl/
922

1023
### Added
1124
- AFCL Table component
25+
- AFCL Chart components and documentation
26+
27+
### Fixed
28+
29+
- two dropdowns now can't be opened at the same time
1230

1331
## [v1.5.10]
1432

README.md

Lines changed: 42 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,64 @@
66

77
* [Try live demo](https://demo.adminforth.dev/) (Read-only mode)
88

9-
* [Hello world in 5 minutes](https://adminforth.dev/docs/tutorial/gettingStarted) with AdminForth.
9+
* [Hello world in 5 minutes](https://adminforth.dev/docs/tutorial/gettingStarted) with AdminForth
1010

11-
* [Full API reference](https://adminforth.dev/docs/api/).
11+
* [Tutorial](https://adminforth.dev/docs/tutorial/Customization/branding/)
12+
13+
<br/>
1214

1315
<div align="center">
14-
<img src="https://github.com/user-attachments/assets/f507a46b-f282-4f81-97e0-32fceb002ded"
15-
alt="Image description" width="800px">
16+
<img src="https://github.com/user-attachments/assets/e643caad-1daa-4085-b125-cc940557a2ec"
17+
alt="AdminForth Dashboard" width="90%">
1618
</div>
1719

18-
Features:
20+
<br/>
21+
22+
Why AdminForth:
1923
* AdminForth is always free and open-source (no paid versions, no cloud subscriptions sh*t)
2024
* Init AdminForth with your database URL in Node.js file, easily describe the tables you wish to see in admin, and get fully functional UI for your data (filter, create, edit, remove)
21-
* Define Vue components to any part (place in data cell, instead of row, add something above the table, inject something to header or sidebar, add custom page with charts)
25+
* Define Vue components to change look of various parts of admin (place in data cell, instead of row, add something above the table, inject something to header or sidebar, add custom page with charts or custom components)
26+
* Rich build-in Components library (AdminForth AFCL) with premade easy-to-use build-blocks which follow your theme
2227
* Define express APIs and call them from your components and pages
23-
* Use various modern back-office-must-have plugins like audit log, files/image upload, TOTP 2FA, Copilot-style AI writing and images generation
28+
* Use various modern back-office-must-have plugins like audit log, files/image upload, TOTP 2FA, I18N, Copilot-style AI writing and image generation
2429

25-
## Previews
30+
## Project initialisation
2631

32+
```
33+
mkdir myadmin && cd myadmin
34+
npx adminforth create-app
35+
```
2736

37+
## Previews
2838

29-
[Custom Dashboard](https://adminforth.dev/docs/tutorial/Customization/customPages):
3039

31-
<div align="center">
32-
<img src="https://github.com/user-attachments/assets/aa899196-f7f3-4582-839c-2267f2e9e197" alt="AdminForth Dashboard demo" width="500px">
33-
</div>
34-
35-
[Chat-GPT plugin](https://adminforth.dev/docs/tutorial/Plugins/chat-gpt):
40+
<table>
41+
<tr>
42+
<td style="width: 40%; vertical-align: top;">
43+
<a href="https://adminforth.dev/docs/tutorial/Customization/customPages">Custom Dashboard</a>
44+
<br/>
45+
<img src="https://github.com/user-attachments/assets/aa899196-f7f3-4582-839c-2267f2e9e197" alt="AdminForth Dashboard demo" width="500px" />
46+
</td>
47+
48+
</tr>
49+
<tr>
50+
<td style="width: 40%; vertical-align: top;">
51+
<a href="https://adminforth.dev/docs/tutorial/Plugins/chat-gpt">Chat-GPT plugin</a>
52+
<br/>
53+
<img src="https://github.com/user-attachments/assets/cfa17cbd-3a53-4725-ab46-53c7c7666028" alt="AdminForth ChatGPT demo" width="500px" />
54+
</td>
55+
</tr>
56+
<tr>
57+
<td style="width: 40%; vertical-align: top;">
58+
<a href="https://adminforth.dev/docs/tutorial/Plugins/upload/#image-generation">Image DALEE Generation</a>
59+
<br/>
60+
<img src="https://github.com/user-attachments/assets/b923e044-7e29-46ff-ab91-eeca5eee2b0a" alt="AdminForth DALE-E image generator demo" width="500px">
61+
</td>
62+
</tr>
63+
</table>
3664

37-
<div align="center">
38-
<img src="https://github.com/user-attachments/assets/cfa17cbd-3a53-4725-ab46-53c7c7666028" alt="AdminForth ChatGPT demo" width="500px">
39-
</div>
4065

41-
[Image DALEE Generation](https://adminforth.dev/docs/tutorial/Plugins/upload/#image-generation)
4266

43-
<div align="center">
44-
<img src="https://github.com/user-attachments/assets/b923e044-7e29-46ff-ab91-eeca5eee2b0a" alt="AdminForth DALE-E image generator demo" width="500px">
45-
</div>
4667

4768

4869
# For developers

adminforth/documentation/docs/tutorial/03-Customization/01-branding.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description: "Learn how to customize the branding and theming of your AdminForth application."
3+
image: "/ogs/branding.png" # Path to the OG image
4+
---
5+
6+
17
# Branding and Theming
28

39
The first things you would probably like to change are the logo, favicon and the name of the application.
@@ -77,11 +83,8 @@ In `index.ts` file set the `styles` property in the configuration:
7783
const admin = new AdminForth({
7884
...
7985
customization: {
80-
//diff-add
8186
styles: {
82-
//diff-add
8387
colors: {
84-
//diff-add
8588
light: {
8689
//diff-add
8790
// color for links, icons etc.
@@ -95,18 +98,15 @@ const admin = new AdminForth({
9598
sidebar: { main: '#f9fafb', text: '#213045' },
9699
//diff-add
97100
sidebar: {main:'#571e58', text:'white'},
98-
//diff-add
99101
},
100-
//diff-add
101102
}
102-
//diff-add
103103
}
104104
},
105105
...
106106
});
107107
```
108108
Here is how it looks:
109-
![alt text](image-10.png)
109+
![AdminForth Themes](image-10.png)
110110

111111

112112

@@ -147,7 +147,7 @@ const admin = new AdminForth({
147147
});
148148
```
149149
Here is how it looks:
150-
![alt text](demo.adminforth.dev_login.png)
150+
![AdminForth Login Background](demo_adminforth_login.png)
151151

152152
You can also set background position and size:
153153

adminforth/documentation/docs/tutorial/03-Customization/04-hooks.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description: "Hooks are powerful tools to modify the data before it is saved to the database, execute something after data were saved or deleted, change the query before fetching items from the database, modify the fetched data before it is displayed in the list and show, and prevent the request to db depending on some condition."
3+
image: "/ogs/hooks.png" # Path to the OG image
4+
---
5+
6+
17

28
# Hooks
39

@@ -25,7 +31,7 @@ Here we will consider possible flows one by one
2531

2632
When user opens edit page, AdminForth makes a request to the backend to get the initial data for the form.
2733

28-
![Initial data for edit page flow](image-28.png)
34+
![Initial data for edit page flow](initial_edit_data_flow.png)
2935

3036
Practically you can use `show.afterDatasourceResponse` to modify or add some data before it is displayed on the edit page.
3137

adminforth/documentation/docs/tutorial/03-Customization/06-customPages.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
description: "Learn how to create custom pages in AdminForth."
3+
image: "/ogs/customPages.png"
4+
---
5+
16
# Custom pages
27

38
Most Admin Panels should have some Dashboards or custom pages.
@@ -15,7 +20,7 @@ Create a Vue component in the `custom` directory of your project, e.g. `Dashboar
1520
<div class="max-w-md w-full bg-white rounded-lg shadow dark:bg-gray-800 p-4 md:p-5" v-if="data">
1621
<div>
1722
<h5 class="leading-none text-3xl font-bold text-gray-900 dark:text-white pb-2">{{ data.totalAparts }}</h5>
18-
<p class="text-base font-normal text-gray-500 dark:text-gray-400">{{ $t('Apartment last 7 days | Apartments last 7 days') }}</p>
23+
<p class="text-base font-normal text-gray-500 dark:text-gray-400">{{ $t('Apartment last 7 days | Apartments last 7 days', data.totalAparts) }}</p>
1924
</div>
2025
<BarChart
2126
:data="apartsCountsByDaysChart"
@@ -120,6 +125,7 @@ Create a Vue component in the `custom` directory of your project, e.g. `Dashboar
120125
<PieChart
121126
:data="apartsCountsByRooms"
122127
:options="{
128+
chart: { type: 'donut'},
123129
plotOptions: {
124130
pie: {
125131
donut: {

0 commit comments

Comments
 (0)