aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d4bd859911aa7708ca9adb118692541bb7ff5828 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
### Scale-API

This is the API of the [scale project](https://git.batnako.net/scale.git).

### Build and Run

Make sure to run `npm update`.
To deploy this api first you have to start the database: `docker-compose up -d db`.
And then run the API: `docker-compose up scale-api`.

### What can it do?

This API is used to save threads and comments from the scale frotend into a PostgreSQL Database.
It uses ExpressJS for doing the API things and Swagger for nice user interface for testing