Skip to content

Commit fded24a

Browse files
authored
Update README.md
1 parent e490802 commit fded24a

1 file changed

Lines changed: 26 additions & 14 deletions

File tree

README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,31 +37,43 @@ Why AdminForth:
3737

3838
## Project initialisation
3939

40-
```
40+
To create an AdminForth project, run:
41+
42+
```bash
4143
npx adminforth create-app
4244
```
4345

44-
## Previews
46+
During the interactive initialization process, AdminForth will ask you to provide a local database URL.
4547

46-
<a href="https://adminforth.dev/docs/tutorial/Customization/customPages">Custom Dashboard</a>
47-
<br/>
48-
<img src="https://github.com/user-attachments/assets/aa899196-f7f3-4582-839c-2267f2e9e197" alt="AdminForth Dashboard demo" width="80%" />
48+
### Integrating AdminForth into your existing application
4949

50-
<a href="https://adminforth.dev/docs/tutorial/Plugins/chat-gpt">Text completion plugin (Copilot-style) using LLMs</a>
51-
<br/>
50+
If you want to build an admin panel for an existing project that already has a database with tables, you can provide the connection URL to your existing development database, such as a local or deployed one.
5251

53-
<img src="https://github.com/user-attachments/assets/cfa17cbd-3a53-4725-ab46-53c7c7666028" alt="AdminForth ChatGPT demo" width="80%" />
52+
After that, you may want to generate AdminForth resource files from your existing database tables:
5453

55-
<a href="https://adminforth.dev/docs/tutorial/Plugins/upload/#image-generation">Image Generation using image generation models</a>
56-
<br/>
57-
<img src="https://github.com/user-attachments/assets/b923e044-7e29-46ff-ab91-eeca5eee2b0a" alt="AdminForth DALE-E image generator demo" width="80%">
54+
```bash
55+
npx adminforth resource
56+
```
57+
58+
Resource files are needed for AdminForth to “know” about your tables and define how to work with them.
59+
60+
Use the command above every time you add new tables or change their schema.
61+
62+
### Starting from scratch
63+
64+
If you do not have a database yet, start an empty local database, for example PostgreSQL in Docker, and provide its URL to the AdminForth CLI.
65+
66+
If the adminforth CLI does not detect any tables, it will suggest adding Prisma as a migration tool. Prisma is not related to AdminForth, but it is one of the most convenient migration tools.
67+
68+
Please follow [getting started](https://adminforth.dev/docs/tutorial/gettingStarted/).
5869

70+
# For AdminForth developers
5971

60-
# For developers
72+
> Follow this section only if you want to make changes to the AdminForth framework or develop a plugin.
6173
62-
The most convenient way to add new features or fixes is using `dev-demo`. It imports the source code of the repository and plugins so you can edit them and see changes on the fly.
74+
The most convenient way to add new features or fixes is to use `dev-demo`. It imports the repository source code and plugins, so you can edit them and see changes on the fly.
6375

64-
# Requirements
76+
## Requirements
6577

6678
- **Node.js 20**
6779
- **Docker**

0 commit comments

Comments
 (0)