README.md

Severless API

SwampHacks API

Structure

Files

• src/
  • handlers/
  • controllers/
  • utils/
  • models/
  • tests/

Architecture

Everything is being hosting on AWS

• API Gateway
• Lambda
• DynamoDB

Contributing

Before getting started, please read the rules on contributing here.

Setup

Install the serverless cli

npm install -g serverless

Install dependencies

yarn

Run the service offline

yarn dev

Tests

Run the test suite and get a coverage report

yarn test