sentinel

A guardian of sentiment

Development

Node

This project was built on Node 15, but requires at least node 14. Install node 14 (15 recommended) via the installation method of your choosing.

Installing Dependencies

Run the following to install all the dependencies and Husky's githooks.

npm install

Lint

Run the following to lint the project files. A successful lint is required for all PRs.

npm test

Test

Run the following to run test using jest. All tests are required to pass for PRs (with coverage).

npm install

Build

Run (local development)

ngrok

Run the following to set up the tunneling.

./node_modules/.bin/ngrok http 3000