README.md

Spotter Serverless API Project

Requirements

Node.js, npm, yarn and serverless dependencies:

npm install -g yarn
yarn -g serverless

How to use

You will need to install multiple dependencies in order to run the API Locally.

# install dependencies
yarn

As this projects uses AWS DynamoDB as a Database, we may use Serverless DynamoDB Local plugin to emulate DynamoDB locally. You have to run the following command to initialize local database:

serverless dynamodb install

And run:

yarn dev

Useful Links:

• Live Documentation Generated with Serverless AWS Documentation plugin (Uploads generated doc to AWS APIGateway, we may then download it in multiple formats like Postman or OpenAPI/Swagger).
• Database Schema
• General Documentation about this project
• Backlog for MVP - Issues and Pull Requests