BookingBug Customer

Requirements

1. Make sure you have a .env file containing

   AWS_ACCESS_KEY_ID="key"
   AWS_SECRET_ACCESS_KEY="key"
   
   BB_CORE_SRC_DIR="/absolute/path/to/core-js"
   BB_CONFIGURATOR_SRC_DIR="/absolute/path/to/configurator-js"
   
   GITHUB_TOKEN="token"
   
   BB_SLACK_TOKEN="token"
   BB_SLACK_URL="url"

2. npm i or npm install will install all the dependencies.

3. Simply run npm start to start the application. You can pass a few options here

   • npm start -- --local core --local configurator will run the application using these modules locally
   • if you then run npm start without 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 8091 will run the server with the port... 8091!

4. npm run deploy -- --env development will deploy your application on /development/. You can't deploy to production, sorry.

5. you can deploy to staging as long as you are on the branch develop. npm run deploy -- --staging will do the magic

6. npm run release {version} will create a release on GitHub (and publish on npm if travis doesn't fail). Pass the semantic version you want to release npm run release minor, npm run release patch, etc

Please remember the -- syntax is necessary to pass params to npm scripts. If you don't really like this syntax, you can try to use yarn which natively support the params without the double dash yarn run start --local core is equivalent to npm start -- --local core

========================================================

Further Documentation

1. API
2. WIKI Documentation