openhouse-backend |

This repository contains all the code for the serverless backend using a SAM template. It defines any additional infrastructure in the CloudFormation stack to support the project (e.g. databases).

Documentation

For full documentation see the repository wiki.

Initializing

Local requirements

• Node.js & Yarn
• SAM CLI
• Docker

$ yarn install

Running API Locally

Ensure the docker engine is running and perform the following steps:

$ yarn run dynamo

This will run DynamoDB in memory in a docker container.

In another terminal run the setup script to configure necessary DynamoDB tables:

$ yarn run setup-dynamo

This must be re-run anytime the yarn run dynamo is restarted. (Note: Your AWS CLI credentials must be configured for this to work. They do not need to be valid however, dummy values will work.)

Finally, run the one of following to build and run the API based on your own OS (& restart this whenever you make a change):

$ yarn run start:win    // Windows
$ yarn run start:mac    // Mac
$ yarn run start:linux  // Linux

Running tests

Run from the root of the project or lambda function directories: yarn test

Deployment

This application is continuously deployed on the develop to the test environment & master to the production environment.