An open API service indexing awesome lists of open source software.

https://github.com/kleros/gtcr-notifications

Handler for GTCR contract events and notifications.
https://github.com/kleros/gtcr-notifications

backend curated-list curated-lists-v1 notifications

Last synced: about 2 months ago
JSON representation

Handler for GTCR contract events and notifications.

Awesome Lists containing this project

README

        


Generalized TCR Notifications


JavaScript Style Guide
Conventional Commits
Commitizen Friendly
Styled with Prettier

Service and database for handling Generalized TCR contract events.

## Prerequisites

- Volta.sh - Recommended
- NodeJS version 14

## Get Started

1. Clone this repo.
2. Duplicate `.env.example`, rename it to `.env` and fill in the environment variables.
3. Run `yarn` to install dependencies and then `yarn start` to run the service in development mode.

### Production

1. Create a `.env` file with the name of the network you wish to use. Example `.env.xdai`.
2. Look into `package.json` for the appropriate script (e.g. start:xdai). Create one if it does not yet exist.
3. Use PM2 like so: `pm2 start yarn --interpreter bash --name gn- -- start:`, replacing `network` with the network name.

Example for xDai:
`pm2 start yarn --interpreter bash --name gn-xdai -- start:xdai`

## Other Scripts

- `yarn format` - Lint, fix and prettify all the project.
.js files with styled components and .js files.
- `yarn run cz` - Run commitizen.