update docs
This commit is contained in:
@@ -3,7 +3,7 @@
|
|||||||
### Install dependencies
|
### Install dependencies
|
||||||
|
|
||||||
```
|
```
|
||||||
$ npm ci
|
$ npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
### Start document server locally
|
### Start document server locally
|
||||||
|
|||||||
@@ -2,7 +2,10 @@
|
|||||||
sidebar_position: 1
|
sidebar_position: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
# ER diagram
|
# Entity Relationship
|
||||||
|
|
||||||
|
<div style={{overflowX: 'auto'}}>
|
||||||
|
<div style={{width: '200%'}}>
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
erDiagram
|
erDiagram
|
||||||
@@ -152,3 +155,6 @@ erDiagram
|
|||||||
timestamp deleted_at
|
timestamp deleted_at
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ Deploy the frontend to Vercel and the backend to Render.
|
|||||||
#### Settings
|
#### Settings
|
||||||
|
|
||||||
| Settings | value |
|
| Settings | value |
|
||||||
| -------------- | ------------------------------------------- |
|
| -------------- | ------------------------------------------------ |
|
||||||
| Root Directory | `backend` |
|
| Root Directory | `backend` |
|
||||||
| Build Command | `npm ci && npm run migrate && npm run seed` |
|
| Build Command | `npm install && npm run migrate && npm run seed` |
|
||||||
| Start Command | `npm run start` |
|
| Start Command | `npm run start` |
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ npm install
|
|||||||
Build frontend code
|
Build frontend code
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
Start frontend server
|
Start frontend server
|
||||||
|
|||||||
17
docs/docs/usage/backup.md
Normal file
17
docs/docs/usage/backup.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Backup
|
||||||
|
|
||||||
|
## Database backup
|
||||||
|
|
||||||
|
UnitTCMS uses SQLite for data persistence. Therefore, backing up the DB is simply backing up the SQLite DB file.
|
||||||
|
|
||||||
|
Please backup the file `backend/database/database.sqlite`
|
||||||
|
|
||||||
|
## Backup of uploaded files
|
||||||
|
|
||||||
|
Uploaded files are managed separately from the DB. If you have uploaded files, you need to backup them too.
|
||||||
|
|
||||||
|
Please backup the files under `backend/public/uploads` directory.
|
||||||
@@ -78,6 +78,9 @@ const config = {
|
|||||||
theme: prismThemes.github,
|
theme: prismThemes.github,
|
||||||
darkTheme: prismThemes.dracula,
|
darkTheme: prismThemes.dracula,
|
||||||
},
|
},
|
||||||
|
mermaid: {
|
||||||
|
theme: { light: 'neutral', dark: 'forest' },
|
||||||
|
},
|
||||||
}),
|
}),
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user