diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..84fcd84 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +### Scale-API + +This is the API of the [scale project](https://git.batnako.net/scale.git). + +### Build and Run + +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 |