Opensource-statistiques 📊

🚧 This project is in progress ...

One objective of this project is to highlight Zenika members for your open source contributions.

To do this, the zenika-open-source GitHub Organization is scanned and data are be saved in a private Database on GCP. Datas could be used to find and list projects maintained or forked by Zenika Members, all projects which Zenika members contributed, etc.

🗄️ Tech

Using :

• Quarkus
• Firestore to save data
• GitHub actions as CICD - 🚧 not implemented

🌐 API

Some resources are available but only the first is in progress :

• /github/ to get information about Zenika Open Source GitHub organization and members from GitHub
• /gitlab/ to get information about Zenika Open Source GitHub organization and members from GitLab 🚧 not implemented
• /members/ to get information from GCP database 🚧 not implemented
• /contributions/ to get information about contributions from GCP database 🚧 not implemented
• /workflow/ to get data and save them on GCP database

🎯 The last one resource will be removed after implementing all features and will be replaced by schedules.

📝 Setup

• You need a GitHub token you can generate on this page.
• Create a .env file based on the .env-example file and set the token previously created.
• You have to create a .gcloud-conf.json to save service account (it's not the best option actually, this can be replaced by another configuration).
• Run the application with quarkus dev if you have the Quarkus CLI installed on your environment, or mvn quarkus:devcommand.
• You can use Quarkus dev service for Firestore enabling this variable quarkus.google.cloud.firestore.devservice.enabled in application.properties file.

✨Contribute

Anyone can contribute to this project. For the moment, please add your question or purpose something in a new issue.