Skip to content

debtcollective/disputes-api

Repository files navigation

Dispute Tools API

This is the API for our Disputes Tools app.

Stack and Libraries

Setup

Database

You need to create databases for development and test environment, you can do that by running these commands.

createdb disputes_development
createdb disputes_test

Now you run migrations with

yarn db:migrate

Dotenv

Run cp .env.sample .env and replace the values with your specific configuration.

Usage

yarn start will run the project in development mode.

Tests

yarn test will run tests. We are using Jest for tests

Notes

esm

We are using esm instead of babel to run the node server. At the moment jest doesn't support esm and we have to use babel.