AbdullahAlabd / Up-Monitor

URL uptime monitoring service with RESTFUL API

Up-Monitor

A URL monitoring service built with NodeJs and MongoDB.

That provides the user with API add URL checks, view statistical reports of the URL availability and be notified once the URL is down or up again.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To be able to run the project on your system you should have:

• Node 18.16.1+ - A cross-platform JavaScript runtime environment.
• MongoDB 6.0+ - A cross-platform document-oriented database program.
• Git - A free and open-source distributed version control system.

Installation

To install the project on your system first open the terminal, then follow the given steps and execute the commands on your terminal.

1. Clone the project from GitHub: git clone https://github.com/AbdullahAlabd/Up-Monitor
2. Switch to the project's directory: cd Up-Monitor/
3. Install the required packages from "package.json": npm install
4. Take a copy of config.env.example file and name it config.env or by running: cp ./src/configs/config.env.example ./src/configs/config.env
5. to be able to send actual emails you can use Twilio SendGrid free plan Find a step-by-step integration guide here
6. update your credentials in config.env.
7. Finally run the app on localhost: node app.js or using Nodemon for easier development npm run dev

Documentation

View the full API documentation:

Author

• Abdullah Alabd - Initial work - Abdullahalabd

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details