|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+# siimee backend API
|
|
|
2
|
+
|
|
|
3
|
+An API for the siimee application
|
|
|
4
|
+
|
|
|
5
|
+## :white_check_mark: Prerequisites
|
|
|
6
|
+
|
|
|
7
|
+You will need...
|
|
|
8
|
+
|
|
|
9
|
+### Node.js 14+
|
|
|
10
|
+* OSX: `brew install node` using [Homebrew](http://brew.sh/)
|
|
|
11
|
+* Linux: `apt install nodejs` ([see Ubuntu/Debian specific instructions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)) or `pacman -S nodejs` (Arch Linux)
|
|
|
12
|
+* Windows: [Install](https://nodejs.org/en/download/)
|
|
|
13
|
+
|
|
|
14
|
+## :package: Installation
|
|
|
15
|
+
|
|
|
16
|
+1. Install dependencies with `npm install`
|
|
|
17
|
+2. Fill out your database connection details in `./config/dev.js`
|
|
|
18
|
+3. A test database container is provided and can be started with `docker-compose up -d`
|
|
|
19
|
+
|
|
|
20
|
+## :electric_plug: Run
|
|
|
21
|
+
|
|
|
22
|
+1. Run `npm run start` to start up the server
|
|
|
23
|
+
|
|
|
24
|
+## :robot: Deployment
|
|
|
25
|
+
|
|
|
26
|
+TBD
|
|
|
27
|
+
|
|
|
28
|
+## :pill: Tests & Code Quality
|
|
|
29
|
+
|
|
|
30
|
+TBD
|
|
|
31
|
+
|
|
|
32
|
+## :heart: Built With
|
|
|
33
|
+
|
|
|
34
|
+* [Hapi](https://hapy.dev/) - Happy APIs
|
|
|
35
|
+* [Objection](https://vincit.github.io/objection.js/) - Light ORM
|
|
|
36
|
+* [Knex.js](https://knexjs.org/) - Query builder
|
|
|
37
|
+* [Schiwfty](https://hapipal.com/docs/schwifty) - Model layer
|
