Uptime-Monitor

Uptime monitoring RESTful API server that allows authenticated users to monitor URLs, and get detailed uptime reports about their availability, average response time, and total uptime/downtime.

Getting Started

These steps will get you a copy of the project up and running for development and testing purposes.

Installation

1. Install Nodejs latest stable version
2. Install npm latest stable version
3. Install mongoDB latest stable version
4. Install redis latest stable version
5. Optional Step ⇒ You can install MongoDB Compass [any user interface application for MongoDB] as it offers a user interface for dealing with the database
6. Clone the Project
7. Run the following commands:

   npm install
   cp .env.example .env
   

8. write required variables in .env

Usage

1. for running localy

npm run start

2. for testing

npm run test

3. for build

npm run build
npm run start:prod

Running Using Docker

1. write required variables in docker-compose.yml
2. Run the following commands:

docker-compose up

API Documentation

Demo

Built With

1. Nodejs
2. Bull (used in handle job scheduling to make App scalable)
3. Redis
4. Mongodb

Todo

• increase test coverage
• deploy app
• handle owasp vulnerabilities