# 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](http://brew.sh/)
* 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)
* Windows: [Install](https://nodejs.org/en/download/)

## :package: Installation

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

## :electric_plug: Run

1. Run `npm run start` to start up the server

## :robot: Deployment

TBD

## :pill: Tests & Code Quality

TBD

## :heart: Built With

* [Hapi](https://hapy.dev/) - Happy APIs
* [Objection](https://vincit.github.io/objection.js/) - Light ORM
* [Knex.js](https://knexjs.org/) - Query builder
* [Schiwfty](https://hapipal.com/docs/schwifty) - Model layer