yellowadmin/pp-tcms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update

Browse Source
This commit is contained in:
Takeshi Kimata
2024-07-18 22:36:35 +09:00
parent 55786e08be
commit 240234d440
4 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/architecture/er.md
View File

@@ -10,7 +10,7 @@ sidebar_position: 1
```mermaid ```mermaid
erDiagram erDiagram
users ||--o{ projects : "user has projects" users ||--o{ projects : "user has projects"
users ||--o{ members : "user has members" users ||--o{ members : "user belongs to the project via the members table"
projects ||--o{ members: "project has members" projects ||--o{ members: "project has members"
projects ||--o{ folders: "project has folders" projects ||--o{ folders: "project has folders"
projects ||--o{ runs: "project has runs" projects ||--o{ runs: "project has runs"

10
docs/docs/getstarted/deployment.md
View File

@@ -33,8 +33,8 @@ 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 install && npm run migrate && npm run seed` | | Build Command | `npm install && npm run migrate` |
| Start Command | `npm run start` | | Start Command | `npm run start` |

2
docs/docs/getstarted/docker.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 2
First, clone the repository. First, clone the repository.
```bash ```bash
git clone git@github.com:kimatata/unittcms.git git clone https://github.com/kimatata/unittcms.git
``` ```
and start containers with the following command. and start containers with the following command.

4
docs/docs/getstarted/manual.md
View File

@@ -15,7 +15,7 @@ To use UnitTCMS, you need run frontend server and backend(API) server.
First, clone the repository. First, clone the repository.
```bash ```bash
git clone git@github.com:kimatata/unittcms.git git clone https://github.com/kimatata/unittcms.git
``` ```
## Run backend server ## Run backend server
@@ -57,5 +57,5 @@ npm run build
Start frontend server Start frontend server
``` ```
PORT=8000 npm run start npm run start
``` ```