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

View File

@@ -8,12 +8,12 @@ import {themes as prismThemes} from 'prism-react-renderer';
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'TestPlat Document',
title: 'TestPlat',
// tagline: 'Dinosaurs are cool',
favicon: 'img/favicon.ico',
// Set the production url of your site here
url: 'https://your-docusaurus-site.example.com',
url: 'https://kimatata.github.io',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/TestPlat/',
@@ -30,8 +30,8 @@ const config = {
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'ja',
locales: ['ja'],
defaultLocale: 'en',
locales: ['en'],
},
presets: [
@@ -59,57 +59,17 @@ const config = {
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'TestPlat Docs',
// logo: {
// alt: 'TestPlat Logo',
// src: 'img/logo.svg',
// },
title: 'TestPlat',
logo: {
alt: 'TestPlat Logo',
src: 'img/android-chrome-192x192.png',
},
items: [
// {
// type: 'docSidebar',
// sidebarId: 'tutorialSidebar',
// position: 'left',
// label: 'Tutorial',
// },
{to: '/docs', label: 'Docs', position: 'left'},
// {to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/facebook/docusaurus',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
// {
// title: 'Docs',
// items: [
// {
// label: 'Tutorial',
// to: '/docs/intro',
// },
// ],
// },
// {
// title: 'Community',
// items: [
// {
// label: 'Stack Overflow',
// href: 'https://stackoverflow.com/questions/tagged/docusaurus',
// },
// {
// label: 'Discord',
// href: 'https://discordapp.com/invite/docusaurus',
// },
// {
// label: 'Twitter',
// href: 'https://twitter.com/docusaurus',
// },
// ],
// },
],
copyright: `Copyright © ${new Date().getFullYear()} TestPlat. Built with Docusaurus.`,
},
prism: {

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 15 KiB