Shreyansh252001 / git-stats

mini project for college

A web application to 🔍 view a github's user profile in a more simple and beautiful way.

📽️ DEMO

👨‍💻 Technology Stack

• React
• styled-components
• React Chart Js 2
• React Icons

API used

• For fetching github's user data : Github API

🐣 Prerequisites

• node >= 12.18.0
• npm >= 6.14.4

⚡ Installation

1. Clone / Download this repo.

2. Inside the project open a terminal and run:

   npm install
   

   This will install all the project dependencies.

3. Create a .env file in the project root folder and add the following:

   REACT_APP_GITHUB_CLIENT_ID = yourClientId
   REACT_APP_GITHUB_CLIENT_SECRET = yourSecretKey 
   

   Replace yourClientId and yourSecretKey with your own Client and Secret Key .

   Get your Client Id and Secret by signing in to your github account and then go to your setting -> developer setting -> OAuth Apps -> New OAuth App

4. To start the development server run:

   npm start
   

🤵‍♂️ Author