Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Byunk authored Dec 19, 2023
1 parent 40901fb commit 9cec83f
Showing 1 changed file with 1 addition and 52 deletions.
53 changes: 1 addition & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 9cec83f

Please sign in to comment.