From d4623316147306fa56e7a5317ea608dff975eb6d Mon Sep 17 00:00:00 2001 From: kartofen Date: Mon, 24 Oct 2022 22:33:47 +0300 Subject: works very good --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md (limited to 'README.md') 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 -- cgit v1.2.3