Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1017 Bytes

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 1017 Bytes
Raw

Contributing

🎉 First off, thanks for taking the time to contribute! 🎉

Architecture

Go to ARCHITECTURE.md

Setting up repo

Install the dependencies.

npm install

Database

The Validator History Service only supports Postgres. You'll need to create a database, but the Validator History Service will create the schema for you.

Linting and testing

Linting

npm run lint

Linting setup as described here.

Testing

npm test

Run

The Validator History Service runs on port 3000.

Non-production

Environment variables are read from the .env file. Copy the variables from .env.example.

You may run the processes like this:

npm run startConnectionsDev & npm run startApiDev

You can start the three processes separately with:

npm run startConnectionsDev
npm run startApiDev
npm run startCrawlerDev