Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soorajshankar/up-beat
self-hosted server uptime monitor.
https://github.com/soorajshankar/up-beat
bulljs docker graphql hacktoberfest hactoberfest mongodb nestjs server-monitoring servermonitor uptime-robot
Last synced: about 2 months ago
JSON representation
self-hosted server uptime monitor.
- Host: GitHub
- URL: https://github.com/soorajshankar/up-beat
- Owner: soorajshankar
- License: apache-2.0
- Created: 2020-03-14T12:55:02.000Z (almost 5 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-24T01:38:22.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T04:28:41.127Z (2 months ago)
- Topics: bulljs, docker, graphql, hacktoberfest, hactoberfest, mongodb, nestjs, server-monitoring, servermonitor, uptime-robot
- Language: TypeScript
- Homepage:
- Size: 10.6 MB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
UpBeat
up-beat - opensource self hosted server health monitor
This project is under development
## Quick Deployment
[](https://heroku.com/deploy?template=https://github.com/soorajshankar/up-beat)
## Description
[Nest](https://github.com/nestjs/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.
```shell
cp example.env .env
```
## Branching model
We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) 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
```bash
$ npm install
```
## Running the app
### Docker instance
```bash
# build docker image
docker-compose build
# build start instance
docker-compose up
```
open browser and navigate to [http://localhost:3000/](http://localhost:3000/)
open graphiQl and navigate to [http://localhost:3000/graphql](http://localhost:3000/graphql)
### Dev server
```bash
# 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/](http://localhost:9000/)
open graphiQl and navigate to [http://localhost:9000/graphql](http://localhost:9000/graphql)
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## License
Nest is [MIT licensed](LICENSE).