Please read the contributors guide for an outline of the workflow and styleguide for working with the application
Node version 10 or greater is required.
.env file in the root of the project if it is not already there. Use this file to override any locally defined environment variables. Otherwise, put the following environment variables in the
For local development
For deployment to AWS
AWS_SECRET_ACCESS_KEY="your access key"
AWS_ACCESS_KEY_ID="your access key ID"
For posting deployment details to slack
BB_SLACK_URL="slack webhook url"
The .env is necessary even if it is empty.
npm i or
npm install will install all the dependencies.
Running the app
npm start to start the application. You can pass a few options here
npm start -- --local core --local configuratorwill run the application using these modules locally
- if you then run
npm startwithout passing any local modules or if you pass different ones, the remaining ones will be reinstalled automatically from the remote specified in the package.json
npm start -- --port 8091will run the server with the port... 8091!
Using the configurator locally
In order for your configurator project to work locally you need ALL of the following parameters:
clientThe name of the configurator project
environmentThe name of the environment in the project
productThe name of the product in the project (Without this one it will not work locally whereas it can be ommitted for a deployed version)
npm run deploy -- --env development will deploy your application on
Please remember the -- syntax is necessary to pass params to npm scripts.
Sometimes webpack dev server compilation doesn't stop when pressing Ctrl+C https://github.com/webpack/webpack-dev-server/issues/1479