soorajshankar/up-beat

self-hosted server uptime monitor.

UpBeat

up-beat - opensource self hosted server health monitor

This project is under development

Quick Deployment

Description

Nest server monitoring system

Environment

Example .env file is given for reference as (example.env). For local development use the following command after cloning the project.

cp example.env .env

Branching model

We use git-flow branching model. The base branch is dev. If you are looking for a stable version, please use the master or tags labelled as v1.x.x.

Installation

$ npm install

Running the app

Docker instance

# build docker image
docker-compose build

# build start instance
docker-compose up

open browser and navigate to http://localhost:3000/ open graphiQl and navigate to http://localhost:3000/graphql

Dev server

# development server
$ yarn start:server

# run react dev server
$ yarn start:client

# rebuild ui and start server
$ npm run start:prodserver

open browser and navigate to http://localhost:9000/ open graphiQl and navigate to http://localhost:9000/graphql

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

License

Nest is MIT licensed.

up-beat's Issues

Intelligent notifier, yeah it should not fill malbox/messenger with spams

Notifications should be non-irrittating is the first thing, maybe one student notification as soon as the first failure, but consequent notifications should be logarithmic. May be 10 mins, 1hr, 24hr so on...

Slack integration

user should be able to add slack api key, alerts should be sent to slack channel

Issue with Heroku deploy template

Jira, Asana, mailchimp, zendesk, and mainly custom WebHook support.

This can be different PR's

Migrate to postgres so that heroku template deployment will happen without asking for CC details.

SMTP notifier with config UI

Setup authentication using passport js (nestjs passport plugin)