Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/erezrokah/serverless-monitoring-app


https://github.com/erezrokah/serverless-monitoring-app

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# Serverless Monitoring App

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Architecture

![Application architecture](images/serverless-monitoring-app.png)

## Prerequisites

[Nodejs](https://nodejs.org/en/) (at least version 16)

[Yarn](https://yarnpkg.com/lang/en/)

Amazon AWS account and `awscli` installed and configured:

Serverless [CLI](https://serverless.com/framework/docs/getting-started/)

## Repository structure

This repository uses [lerna](https://lernajs.io/) 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

```bash
yarn install
```

Setup environment file

```bash
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/[email protected]/g' services/monitoring-common/environment/config.dev.json
```

## Deploy

Deploy all services and frontend

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

## Run Prettier

```bash
yarn prettier
```

## Run Linter

```bash
yarn lint
```

## Run Tests

```bash
yarn test
```

```bash
yarn coverage
```

## Cleanup

Removes all services and frontend

```bash
yarn remove:all:dev
```