siimee backend API

An API for the siimee application

:white_check_mark: Prerequisites

You will need…

Node.js 14+

OSX: brew install node using Homebrew
Linux: apt install nodejs (see Ubuntu/Debian specific instructions) or pacman -S nodejs (Arch Linux)
Windows: Install

:package: Installation

Install dependencies with npm install
Fill out your database connection details in ./config/dev.js
A test database container is provided and can be started with docker-compose up -d

:electric_plug: Run

Run npm run start to start up the server

:robot: Deployment

TBD

:pill: Tests & Code Quality

TBD

:heart: Built With

Hapi - Happy APIs
Objection - Light ORM
Knex.js - Query builder
Schiwfty - Model layer