- NodeJS v4.0+
- NPM v3.10+
- macOS or Linux (not tested on Windows)
We use NPM scripts for all development related tasks.
The main git branch is 2X
We use rebasing in order to avoid merge commits.
We have pre-commit/push hooks in the
hooks directory to help enforce our linting rules and tests. Developers are highly encouraged to use them.
Configure your dev envirnoment
We use a shell script to run the app so we can define needed environment variables. By convention we call it
start.sh. This file is already in our
cp start.sh.example start.sh
chmod u+wx start.sh
Make sure to update the script with the appropriate secrets and other necessary values.
npm run watch
npm run build
running the app
Instead of running the npm script that starts the server make sure to use your
start.sh with the appropriate keys so you can log in.