A Flask-based web application that provides insights into your GitHub activity patterns, helping you understand your contributions and track your coding journey.
Features (Planned):
- Interactive Visualizations: Gain insights with dynamic charts and graphs of your GitHub activity.
- Customizable Filters: Select repositories and date ranges to focus your analysis.
- GitHub Authentication: Securely authenticate through GitHub OAuth to access your private data.
- Commitment and Contribution Metrics: Visualize commits, contributions, and other relevant data.
Live Demo (Link will be updated upon deployment):
https://your-deployed-app-url.herokuapp.com
Project Blog Post:
[Your Blog Post URL]([Your Blog Post URL])
- Attahiru Kamba
-
Clone the Repository:
git clone [invalid URL removed]
-
Create a Virtual Environment (Recommended):
python -m venv venv
-
Activate the Virtual Environment:
venv\Scripts\activate # Windows source venv/bin/activate # macOS/Linux
-
Install Dependencies:
pip install -r requirements.txt
-
Set up Environment Variables:
- Create a
.envfile in the project root and add your GitHub OAuth credentials and MongoDB URI:GITHUB_CLIENT_ID=your_github_client_id GITHUB_CLIENT_SECRET=your_github_client_secret MONGO_URI=your_mongodb_uri
- Create a
-
Start the Development Server:
python app.py
-
Access the Application:
- Open your browser and visit
http://127.0.0.1:5000. - (For development with HTTPS, you can use ngrok or a similar tool).
- Open your browser and visit
-
Log in with GitHub: Click on the "Login with GitHub" button and follow the authorization prompts.
-
Explore and Visualize Your Activity: (Detailed instructions on using the app's features will be added later)
Contributions are welcome! Please feel free to submit issues or pull requests to help improve the project.
- [Other similar projects you find relevant]
This project is licensed under the MIT License.