mado007 / dragon-guard Goto Github PK

Dragon Park Dashboard is a tool designed to enhance the safety and efficiency of Dragon Park operations by providing real-time information about the status of park zones.

• Introduction
• Requirements
• Installation and Setup
• Usage
• API Documentation
• Testing
• Insights
• Frontend Dashboard
• Contributing
• License

Dragon Park Dashboard consists of a backend service built with Flask to process events from the New Unified DragonPark Logging System (NUDLS™) and expose the status of park zones through a RESTful API. The backend is complemented by a simple frontend dashboard that displays the grid of zones.

Ensure you have the following dependencies installed:

• Python 3
• Flask

1. Clone the repository:

   git clone https://github.com/Mado007/dragon-guard
   cd dragon-guard

2. Set up a virtual environment (optional but recommended):

   python3 -m venv venv
   source venv/bin/activate   # On Windows, use 'venv\Scripts\activate'

3. Install dependencies:

   pip install -r requirements.txt

4. Run the Flask app:

   python app.py --port 5000

• Access the Dragon Park Dashboard at http://127.0.0.1:5000/.
• NUDLS events can be sent to the /nudls endpoint for processing.

• GET /zones: Fetch a list of all zones and their statuses.
• GET /zones/:zoneId: Retrieve details for a specific zone.

curl -X GET http://127.0.0.1:5000/zones

1. Start your application according to the instructions in the readme file.
2. Run the provided Postman collection against your API.
3. Make requests (based on your documentation) to determine the status of each zone.

Given the critical nature of the software, the backend ensures high availability with the following measures:

• Utilization of load balancing.
• Implementation of failover mechanisms.
• Regular monitoring and automated alerts for system health.

In anticipation of housing over 1 million dragons, potential areas of concern include:

• Database scalability for handling increased data.
• Optimized algorithms for processing large datasets efficiently.

• Displays a grid of zones in a tabular format.
• Color-coded indicators for zone status (green for safe, red for maintenance).
• Basic search functionality for finding specific zones.
• Details view for each zone, including the last maintenance date and carnivore presence.
• Manual refresh button to fetch the latest data from the backend.

Basic user authentication is implemented to restrict access to authorized personnel.

Contributions are welcome! Feel free to open issues, submit pull requests, or provide feedback.

This project is licensed under the MIT License.

Copyright © 2023 Mahmoud Eid.
https://github.com/Mado007/dragon-guard with the actual URL of your GitHub repository. Adjust the content as needed, and make sure to update the instructions and documentation based on the specific details of your project. This README was generated with ❤️ by Mahmoud Eid