From 2f6010d960f5e84ec366a6d89fe90a468daa20b4 Mon Sep 17 00:00:00 2001 From: Takeshi Kimata <117462761+kimatata@users.noreply.github.com> Date: Sun, 7 Jul 2024 18:29:28 +0900 Subject: [PATCH] update docs --- docs/README.md | 2 +- docs/docs/architecture/er.md | 8 +++++++- docs/docs/getstarted/deployment.md | 10 +++++----- docs/docs/getstarted/manual.md | 2 +- docs/docs/usage/backup.md | 17 +++++++++++++++++ docs/docusaurus.config.js | 3 +++ 6 files changed, 34 insertions(+), 8 deletions(-) create mode 100644 docs/docs/usage/backup.md diff --git a/docs/README.md b/docs/README.md index b0accf1..9599f5e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,7 +3,7 @@ ### Install dependencies ``` -$ npm ci +$ npm install ``` ### Start document server locally diff --git a/docs/docs/architecture/er.md b/docs/docs/architecture/er.md index d9c5cbe..698c5cd 100644 --- a/docs/docs/architecture/er.md +++ b/docs/docs/architecture/er.md @@ -2,7 +2,10 @@ sidebar_position: 1 --- -# ER diagram +# Entity Relationship + +
+
```mermaid erDiagram @@ -152,3 +155,6 @@ erDiagram timestamp deleted_at } ``` + +
+
diff --git a/docs/docs/getstarted/deployment.md b/docs/docs/getstarted/deployment.md index 156c563..93263f9 100644 --- a/docs/docs/getstarted/deployment.md +++ b/docs/docs/getstarted/deployment.md @@ -33,8 +33,8 @@ Deploy the frontend to Vercel and the backend to Render. #### Settings -| Settings | value | -| -------------- | ------------------------------------------- | -| Root Directory | `backend` | -| Build Command | `npm ci && npm run migrate && npm run seed` | -| Start Command | `npm run start` | +| Settings | value | +| -------------- | ------------------------------------------------ | +| Root Directory | `backend` | +| Build Command | `npm install && npm run migrate && npm run seed` | +| Start Command | `npm run start` | diff --git a/docs/docs/getstarted/manual.md b/docs/docs/getstarted/manual.md index d3170ef..0897e65 100644 --- a/docs/docs/getstarted/manual.md +++ b/docs/docs/getstarted/manual.md @@ -51,7 +51,7 @@ npm install Build frontend code ```bash -npm run dev +npm run build ``` Start frontend server diff --git a/docs/docs/usage/backup.md b/docs/docs/usage/backup.md new file mode 100644 index 0000000..699ed94 --- /dev/null +++ b/docs/docs/usage/backup.md @@ -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. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 1f91940..638ec45 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -78,6 +78,9 @@ const config = { theme: prismThemes.github, darkTheme: prismThemes.dracula, }, + mermaid: { + theme: { light: 'neutral', dark: 'forest' }, + }, }), };