UptimeMon is a web application that monitors the availability of specified hosts using ping requests.
Make sure you have Docker installed on your machine.
Follow the official Docker installation guide: Install Docker
git clone https://github.com/Arteiii/uptimeMon.git
cd uptimeMonNote: Docker Compose is required to run this project. If you don't have Docker Compose installed, you can download it here.
Before beginning, ensure to configure the address of the API endpoint (the backend application) within the Nextjs config of the frontend (/frontend/next.config.js). Set the environment variable API_URL to match your backend URL.
Run Docker Compose
sudo docker-compose up --buildFor more information about Docker usage, check the Docker Documentation.
This command sets up a MongoDB container and containers for the frontend and backend. The application will be available at http://localhost:5000.
The frontend is built with Next.js, a fast web development build tool. It provides a user interface to view the ping status of specified hosts.
The backend of UptimeMon is powered by FastAPI, which comes with automatic API documentation.
You can explore and interact with the API directly from your browser.
Once the application is running, you can access the automatic API documentation at:
- Swagger UI: http://localhost:5000/docs
- ReDoc: http://localhost:5000/redoc
These interfaces provide a detailed overview of the available API endpoints, request parameters, and response structures.
Once the application is running, you can access the frontend at http://localhost:5000.
The user interface allows you to specify hosts and view their ping status.
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.