maakaf-stats is an open-source project that aims to collect and analyze data about the Maakaf community.
maakaf stats currently in beta and under active development. While it offers exciting new features, please note that it may not be stable for production use.
-
Install docker and docker-compose
-
Run the following commands in the root directory of the project:
docker compose up airflow-init
docker compose up - Wait a few seconds for the containers to finish starting ( you can include -d to run in detached mode)
-
Open the browser and go to the port depends on the service you want to use (grafana, airflow, etc.)
-
Enjoy!
- To kill the containers:
docker compose down- Airflow - Being used to schedule and monitor the data collection process.
- Grafana - Being used to visualize the data collected.
- Elasitcsearch - Being used to store the logs.
- Kibana - Being used to visualize the logs.
- Docker - Being used to containerize the services.
- Docker-compose - Being used to manage the containers.
- Python - Being used to write the data collection scripts.
- Postgres - Being used to store the data.
- FastAPI - Being used to provide the data to other projects.
Maakaf Stats aims to offer a straightforward and efficient way to collect and analyze data about our community.
Our goal is to support the development and growth of both the community and its members.
- Grafana: To visualize the communitys stats.
- API Service: To provide the options to other projects to use the data collected by the service.
If you want to say Thank You and/or support the active development of maakaf-stats feel free to add a GitHub Star to the project.
To ensure your contributions are ready for a Pull Request, please use the following Makefile commands. These tools help maintain code quality, consistency.
Copyright (c) 2024-present. Maakaf-stats is free and open-source software licensed under the MIT License.