Skip to content

satyajitnayk/uptime-monitor

Repository files navigation

🌐 URL Uptime Monitoring System 🚀

Node.js TypeScript

A simple and elegant URL uptime monitoring system built using Node.js and TypeScript.

Features

  • ⏰ Schedule periodic checks to monitor URLs' uptime.
  • 📊 Track historical uptime and downtime statistics.
  • 📧 Receive email notifications for critical events.
  • 📈 Real-time dashboard for monitoring status.

Installation

  1. Ensure you have Node.js (v14.17.4 or higher) and TypeScript (v4.3.5 or higher) installed.
  2. Clone this repository: git clone https://github.com/satyajitnayk/uptime-monitor
  3. Install dependencies: npm install
  4. Build the project: npm run build
  5. Start the server: npm start
image

Usage

  1. Run the server: npm start
  2. Access the dashboard: Open your browser and navigate to http://localhost:3000.

API Endpoints

Postman Collection Link: https://documenter.getpostman.com/view/19777887/2s8ZDYWLmQ

Contributing

We welcome contributions! To contribute to this project, follow these steps:

  1. Fork this repository.
  2. Create a new branch: git checkout -b feature/your-feature-name.
  3. Commit your changes: git commit -m "Add your feature".
  4. Push the branch: git push origin feature/your-feature-name.
  5. Open a pull request.

Please ensure that your code follows our coding standards and passes all tests.

🙏 Thank you for using our URL Uptime Monitoring System! We hope it helps you keep your websites and services online 24/7. If you encounter any issues or have suggestions, please feel free to create an issue or reach out.

Happy monitoring! 👀