README.md

Serverless Monitoring App

Architecture

Prerequisites

Nodejs (at least version 16)

Yarn

Amazon AWS account and awscli installed and configured: https://aws.amazon.com/getting-started/

Serverless CLI

Repository structure

This repository uses lerna and yarn workspaces to handle dependencies.

The React frontend app sits under frontend/.

"Back-end" services sit under services/.

Typescript is used across the repository.

Setup

Install Dependencies

yarn install

Setup environment file

cp -f services/monitoring-common/environment/config.example.json services/monitoring-common/environment/config.dev.json
sed -i '' 's/REGION_VALUE/us-east-1/g' services/monitoring-common/environment/config.dev.json
sed -i '' 's/ADMIN_EMAIL_VALUE/your@email.address/g' services/monitoring-common/environment/config.dev.json

Deploy

Deploy all services and frontend

yarn deployAndRunE2eTests --commitId "0000000000000000" --stage dev --forceAll true

Run Prettier

yarn prettier

Run Linter

yarn lint

Run Tests

yarn test

yarn coverage

Cleanup

Removes all services and frontend

yarn remove:all:dev