Gitnalysis

Backend Code

📖 Table of Contents

Table of Contents

1. ➤ About The Project
2. ➤ Built With
3. ➤ Select a Repository
4. ➤ View Statistics
5. ➤ Check Notifications
6. ➤ Credits
7. ➤ To Contribute

📝 About The Project

As a group of eight, we developed a dynamic web app that enhances a developer's experience with GitHub. In one centralized location, a user can view in-depth numbers, trends, and data visualizations about any of their repositories. Some of the statistics include the Average Lead Time for Change, Pull Request Merge Success Rate, Comments Per Code Ratio, and Issues/Commits Timelines. It's as simple as logging in with GitHub and choosing a repository.

🛠️ Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

🔎: Select A Repository

📊: View Statistics

🔔: Check Notifications

📜 Credits

Andrea Tranchina

Saoirse Siobhan Ebert

Jonathan Shabatayev

Hafeefa Sultan

Ghulam N. Ahmed

Rasul Nekzad

Hamza Khaliq

📖 To Contribute

This project was bootstrapped with Create React App.

In the project directory, you can run:

npm i

This will install all necessary dependencies.

In addition to this, you must input your own API keys in a .env.local file that looks like this:

REACT_APP_DEEPL_API_KEY=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_TOKEN=
FRONTEND_URL='http://localhost:3000'
BACKEND_URL='http://localhost:8080'

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.