siimee/backend/README.md

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

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
4. Populate some basic tables for your database using npx knex migrate:latest

: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 - Happy APIs
• Objection - Light ORM
• Knex.js - Query builder
• Schiwfty - Model layer