API server for the Backbone app
- Node.js 6.11.1 (Use the exact version as this is currently the Node.js version we use in AWS)
- MongoDB 3.2.8
Use Yarn instead of npm to install package dependencies. Using Yarn will ensure you get the same dependency versions. Assuming you already have Yarn installed, simply run yarn install from the project root.
Ensure the MongoDB server is running before launching the API server.
Ask another developer for the following environment variables values, which you'll store in your .env.local file (create the file if it doesn't already exist):
- BL_ACCESS_TOKEN_SECRET
- BL_MAILGUN_API
- FB_APP_SECRET
By default, emails will not be sent in development mode. To have emails be sent, set the BL_SILENT_EMAIL environment variable to false. Furthermore, emails sent in development mode will be sent to the email address specified in BL_TEST_EMAIL, so feel free to set it to an email address you have access to by storing it in your .env.local file.
Production releases should be triggered from the production branch. Therefore, master could be ahead of production because we may merge in new changes but delibrately hold off on releasing until a later time. Using a separate branch for releases will allow us to further test and perform QA before releasing to the wild.
- Make sure you have the Elastic Beanstalk CLI installed and configured. See http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3.html.
- Set the backbone-api-staging environment as the default environment in the EB CLI to prevent accidental deployments to production.
- Checkout to the
productionbranch and merge in the latestmaster. - Deploy to staging first by running
eb deploy backbone-api-staging. - After it is deployed to staging, check the status of the staging environment in the AWS Elastic Beanstalk console to make sure there are no issues.
- Deploy to the production environment by going to the backbone-api application in the Elastic Beanstalk console and clicking on the "Application versions" link on the left-hand side and then selecting the latest version to deploy to the backbone-api-prod environment.