RFCx Guardian API

Manages incidents and responses. Consumed by Guardian App and Guardian Dashboard

---

Getting started

Requirements:

• Node 14.17.6 (can be installed via nvm module and .nvmrc file)
• yarn

Install dependencies

yarn

Configure env variables

Copy .env.example to .env. Set DB credentials there.

Setup TimescaleDB locally using Docker

Start TimescaleDB container

yarn start.timescale

Run the migrations

On local machine (to apply env vars from .env file)

yarn migrate.dev

When you want to stop TimescaleDB

yarn stop.timescale

Run local dev server (live reload)

yarn serve

Testing

Run lint

yarn lint

Run tests

yarn test

---

More information

• Deployment