Skip to content

melvinchia3636/gitinfo

Repository files navigation

🗄 Git Dev Info

A nice looking API explorer of Github REST API.

The Problem

  • I don't like Github UI too much. 😕
  • I need a project to work on. 😎
  • Github API is a true mess. 😖
  • I can't view everything about a Github repo or Github account at a single page 😑

The Solution

I've made a web app that allows users to search for Github accounts and repositories and display the corresponding data in a clear and easy-to-read manner.

🖥 Screenshots

Screenshot 2022-01-08 at 1 50 00 PM Screenshot 2022-01-08 at 1 50 12 PM Screenshot 2022-01-08 at 1 50 30 PM Screenshot 2022-01-08 at 1 50 38 PM Screenshot 2022-01-08 at 1 50 47 PM Screenshot 2022-01-08 at 1 50 57 PM Screenshot 2022-01-08 at 1 51 06 PM Screenshot 2022-02-02 at 6 01 16 AM Screenshot 2022-02-02 at 6 04 08 AM

🔬 Technologies Used

skills skills skills skills skills skills

⌨️ Setup

If you want to run the website on your local machine:

  1. Clone the repository: git clone https://github.com/melvinchia3636/gitinfo
  2. Install all required dependencies using npm install
  3. Create a .env file in the project root folder and put your github API key inside: REACT_APP_API_KEY = 'YOUR_API_KEY'
  4. Run npm start and you're good to go.

📈 Status

This project is still under development, new features are being added constantly. If any bugs are found, please file an issue here, and I'll resolve it ASAP.

💡 Inspirations

This project was inspired by Allicodes' Git-Find project, which allows users to search for relevant information about any Github account as part of the #31daysofdevelopment event.

📄 License

Copyright © 2022 Melvin Chia
Licensed under MIT.