From 9cec83fe451dc793ca0ce77a9e9fe2bcbecd43bb Mon Sep 17 00:00:00 2001 From: Kyungho Byoun Date: Tue, 19 Dec 2023 23:35:31 +0900 Subject: [PATCH] Update README.md --- README.md | 53 +---------------------------------------------------- 1 file changed, 1 insertion(+), 52 deletions(-) diff --git a/README.md b/README.md index 2845647..4b3e519 100644 --- a/README.md +++ b/README.md @@ -9,57 +9,6 @@ KAIST board of audit and inspection system backend - `Redis` - `sequelize` as a ORM -## Usage - -Is it recommended to run with [Docker](https://www.docker.com/) - -First off, setup .env with DB and S3 information. - -``` -mv .env.sample .env -``` - -For local execution, default environmental variables of database is as following: - -``` -DB_HOST = postgresql -DB_PORT = 5432 -DB_USER = postgres -DB_PASSWORD = password -``` - -### In production - -``` -docker compose up -``` - -### In development - -``` -docker compose -f compose-dev.yaml up - -// set node version, or you can manually install `node:v18.12.0` -nvm install -nvm use - -npm run dev -``` - -## Testing - -``` -npm test -``` - ## API Document -``` -npm run dev -``` - -Enter to `localhost:1313/api-docs`. - -## ER-Diagram - -![감사원 drawio](images/감사원.drawio.png) +[API document](dev-bai.gdsckaist.com/api-docs)