Git-Stats Stats

This project is a simple web application designed to track your GitHub statistics using GitHub's API. The main goal of this project was to learn and practice working with APIs in a real-world scenario.

                                      ,--,                       
  ,----..              ___          ,--.'|                       
 /   /   \    ,--,   ,--.'|_     ,--,  | :               ,---,   
|   :     : ,--.'|   |  | :,' ,---.'|  : '         ,--,,---.'|   
.   |  ;. / |  |,    :  : ' : |   | : _' |       ,'_ /||   | :   
.   ; /--`  `--'_  .;__,'  /  :   : |.'  |  .--. |  | ::   : :   
;   | ;  __ ,' ,'| |  |   |   |   ' '  ; :,'_ /| :  . |:     |,-.
|   : |.' .''  | | :__,'| :   '   |  .'. ||  ' | |  . .|   : '  |
.   | '_.' :|  | :   '  : |__ |   | :  | '|  | ' |  | ||   |  / :
'   ; : \  |'  : |__ |  | '.'|'   : |  : ;:  | : ;  ; |'   : |: |
'   | '/  .'|  | '.'|;  :    ;|   | '  ,/ '  :  `--'   \   | '/ :
|   :    /  ;  :    ;|  ,   / ;   : ;--'  :  ,      .-./   :    |
 \   \ .'   |  ,   /  ---`-'  |   ,/       `--`----'   /    \  / 
  `---`      ---`-'           '---'                    `-'----'  
  .--.--.       ___                   ___                        
 /  /    '.   ,--.'|_               ,--.'|_                      
|  :  /`. /   |  | :,'              |  | :,'                     
;  |  |--`    :  : ' :              :  : ' :  .--.--.            
|  :  ;_    .;__,'  /    ,--.--.  .;__,'  /  /  /    '           
 \  \    `. |  |   |    /       \ |  |   |  |  :  /`./           
  `----.   \:__,'| :   .--.  .-. |:__,'| :  |  :  ;_             
  __ \  \  |  '  : |__  \__\/: . .  '  : |__ \  \    `.          
 /  /`--'  /  |  | '.'| ," .--.; |  |  | '.'| `----.   \         
'--'.     /   ;  :    ;/  /  ,.  |  ;  :    ;/  /`--'  /         
  `--'---'    |  ,   /;  :   .'   \ |  ,   /'--'.     /          
               ---`-' |  ,     .-./  ---`-'   `--'---'           
                       `--`---'                                  

GitHub Stats is a simple and engaging web application designed to help you track and visualize your GitHub activity and achievements. By connecting to GitHub's API, this tool provides you with insightful data on your coding journey, allowing you to monitor your progress and celebrate milestones with fun, collectible badges.

Features

• GitHub Stats Visualization: Easily visualize your GitHub statistics, including repositories, stars, forks, commits, and more through a clean and intuitive interface.
• Achievement Badges: Earn and display badges for various accomplishments, such as reaching a certain number of stars or making your first public repo
• Real-Time Data: Fetch up-to-date information directly from your GitHub profile using GitHub's API, ensuring you always have the latest stats at your fingertips.
• User-Friendly Interface: A simple yet elegant web interface that makes it easy to explore your GitHub data and track your progress over time.

Installation

1. Clone Repository :

git clone https://github.com/Balcus/Git-Stats.git

2. Navigate to Project Directory :

cd Git-Stats

3. Set Up a Virtual Environment (optional but recommended):

python -m venv env
source env/bin/activate  # On Windows, use `env\Scripts\activate`

4. Install the Required Packages :

pip install -r requirements.txt

5. Run the Application:

python app.py

6. Access the Web App: Open your web browser and go to http://127.0.0.1:5000 to view your GitHub stats.

Usage

1. Start the Web Application: Follow the installation instructions to run the application. Once it's running, open your browser and navigate to the provided local address.

2. Provide the username you'd like to search for. Optionally, you can also include a GitHub Token to increase your request limit

3. Visualize Your GitHub Stats: Explore your GitHub profile's data, including repositories, commits, stars, and more. The web app provides a clear and organized view of your GitHub activity.

4. Earn Achievement Badges: Reach specific milestones such as: Constellation Complete or Branching Out.

5. Customize or Expand the Project (optional): Feel free to modify the code to add more features, customize the interface, or tailor the badges to better suit your preferences.

Contact

For any questions or feedback, please reach out via:

• Email: bbalcus04@gmail.com
• GitHub Issues: Issues

Thank you for using Git-Stats!