This project uses Serverless Framework to deploy AWS resources.
npm install -g serverless
Under the hood, Serveless Framework uses AWS CLI. Install and configure it following AWS CLI docs
First, install node dependecies
npm install
Use provided npm commnads to deploy
npm run deploy # deploys on default stage from serverless.yaml (dev)
In order to deploy on production:
npm run deploy:prod
This project generates documentation using TypeDoc. The easiest way is run a server on aws/docs/
. I recommend VS Code extensions LiveServer
Install dependecies and run the server locally
npm i
npm run dev
WIP