ServiceDown-api

Open Services Status Data

The API of Service Down

With this project I want to make services status information open data. With a bunch of metrics like the number of reports, average report, in which region ...

More than 230 services is available in 2 country (FR & US).

Get stated 🚀

installation

To install ServiceDown-api, you need to install some things :

• Python 3.9
• pip
• Django 4.0.4
• Install requirements.txt with pip install -r requirements.txt
• Create file .env in ServiceDown_api/service_down with properties :
  • DEBUG: [Boolean] True for dev and False for Prod
  • SECRET_KEY: [String] Django Secret key
  • DB_HOST: [String] IP Address or domain name of database server
  • DB_PORT: [Number] Number of port used by database service
  • DB_NAME: [String] Name of database
  • DB_USER: [String] Name of user
  • DB_PASSWORD: [String] Password of user
  • DB_ROOT_PASSWORD [String] Password for root user (using password: YES)

Use

Applied migrations : python manage.py migrate
Make fixtures (seed database) with custom command : python manage.py loadfixtures
Run server : python manage.py runserver

Using Docker Compose

• Up containers : (on project root directory) docker-compose --env-file=service_down/.env up
• Down containers : (on project root directory) docker-compose --env-file=service_down/.env down

Roadmap

• v1.1: Service categories
• v1.5 "Log4me" Log actions and send it to the Discord Bot
• v2: Auth and user account

Version

• [coming soon][v1] First API version with basic actions

Contributors

• 👑 Benjamin Fourmaux

Licence

All Service Down project's is under Apache License v2. You can:

• Reuse the code
• Modified the code
• Build the code

You must Mention the © Copyright if you use and modified code for your own profit. Thank you

Supporting

If you like this project and if you want, make a donation

Social Networks