master is unsafe, please refer to tags.
An api wrapping the belenios-tool command line.
For more information about the Belenios voting system you can refer to this repository Belenios.
- From the project root directory, run
yarnto install dependencies. - Add
.../dependencies/belenios/_build/install/default/binto path environment variable.
- Linter:
yarn test:lint - Unit Tests:
yarn test:unit - Both:
yarn test
- Create a copy of each {stage}.sample.js files to {stage}.sample.js.
- Enter the missing information in the setting files.
- Run command:
- In development:
yarn deploy {yourPersonalStage} - In demo:
yarn deploy:demo - In staging:
yarn deploy:staging - In production:
yarn deploy:production
- In development:
yarn undeploy {yourPersonalStage} - In demo:
yarn undeploy:demo - In staging:
yarn undeploy:staging - In production:
yarn undeploy:production
Never commit directly on master, instead use branches and pull requests.
Once approved, a Pull request is merged in master by its author. Also, it must be squashed before merging,
either manually or using GitHub's Squash and merge feature.
You must use the following Style Guides :
This project contains a linting config, you should setup eslint into your IDE with .eslintrc.js.
Please refer to the Issues section if you encounter any problems during development.
For technical documentation refer to doc folder.
Once deploy you can go directly to the endpoint and the Apollo Studio will automatically show the latest API doc in pair with a playground.