This Django project is designed to monitor the online status of stores based on provided data sources. It includes backend APIs to generate reports on store uptime and downtime within specific time intervals.
The primary goal of this project is to address the need for real-time monitoring of store activity. By leveraging data from multiple sources, including CSV files containing store status, business hours, and timezone information, the system aims to provide accurate and timely insights for restaurant owners.
-
Store Status CSV: Contains information about whether the store was active or inactive at specific timestamps.
-
Business Hours CSV: Provides business hours for all stores, including day of the week, start time, and end time.
-
Timezone CSV: Specifies the timezone for each store.
- The data is not static; the system should dynamically handle updates every hour.
- CSV data is stored in a relevant database, and API calls are made to retrieve the data.
- Clone the repository:
git clone https://github.com/JathinShyam/Django-StoreStatus.git
- Install project dependencies:
pip install -r requirements.txt
- Apply database migrations:
python manage.py migrate
- Create a superuser(admin):
python manage.py createsuperuser
- Run the development server:
python manage.py runserver
The project should now be accessible at http://localhost:8000/.
The system outputs a report to the user with the following metrics:
store_id, uptime_last_hour (in minutes), uptime_last_day (in hours), uptime_last_week (in hours), downtime_last_hour (in minutes), downtime_last_day (in hours), downtime_last_week (in hours)
/trigger_report: Endpoint to trigger report generation.
Input: No input required.
Output: Report ID (random string).
/get_report: Endpoint to retrieve the status of the report or the CSV file.
Input: Report ID.
Output: If report generation is not complete, return "Running." (Under process)
If report generation is complete, return "Complete" along with the CSV file.