Move docs to docusaurus site

This commit is contained in:
Takeshi Kimata
2024-05-12 13:59:35 +09:00
parent af7cdb790e
commit 2b3dec3c12
17 changed files with 120 additions and 245 deletions

View File

@@ -1,8 +1,4 @@
{
"label": "Architecuture",
"position": 2,
"link": {
"type": "generated-index",
"description": "Architecuture"
}
"position": 3
}

View File

@@ -0,0 +1,4 @@
{
"label": "Get started",
"position": 2
}

View File

@@ -0,0 +1,7 @@
---
sidebar_position: 2
---
# Running TestPlat as a Docker container
##

View File

@@ -0,0 +1,55 @@
---
sidebar_position: 3
---
# Running TestPlat manually
:::info[Prerequisite]
Prerequisite: v20 or higher node must be installed.
:::
To use TestPlat, you need run frontend server and backend server (API server).
First, clone the repository.
```bash
git clone git@github.com:kimatata/TestPlat.git
```
## Run backend server
Moves to backend directory, then install dependencies.
```bash
cd backend
npm ci
```
Initialize the database with the following command.
```bash
npm run migrate
```
Start backend server.
```bash
node index
```
## Run frontend server
Moves to frontend directory, then install dependencies.
```bash
cd frontend
npm ci
```
Start frontend server
```bash
rpm run dev
```

View File

@@ -0,0 +1,10 @@
---
sidebar_position: 1
---
# Self hosting
TestPlat is designed for self-hosted use. There are two ways to self-host the application: “Manual” and “Docker”.
- Docker (Recommended)
- Manual