https://github.com/melvinchia3636/gitinfo

A nice looking API explorer of Github REST API.
https://github.com/melvinchia3636/gitinfo

api api-explore api-explorer colorful-interface github github-api react reactjs tailwindcss ui ui-design

Last synced: 20 days ago
JSON representation

A nice looking API explorer of Github REST API.

• Host: GitHub
• URL: https://github.com/melvinchia3636/gitinfo
• Owner: melvinchia3636
• License: mit
• Created: 2022-01-05T06:55:00.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-17T08:20:47.000Z (almost 2 years ago)
• Last Synced: 2024-07-30T20:57:39.648Z (4 months ago)
• Topics: api, api-explore, api-explorer, colorful-interface, github, github-api, react, reactjs, tailwindcss, ui, ui-design
• Language: JavaScript
• Homepage: https://gitinfo.thecodeblog.net
• Size: 5.11 MB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
🗄 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





















  



## 🔬 Technologies Used 

![skills](https://img.shields.io/badge/-JAVASCRIPT-FF0000?style=for-the-badge&logo=javascript&logoColor=white&color=red)

![skills](https://img.shields.io/badge/-HTML-FF0000?style=for-the-badge&logo=html5&logoColor=white&color=green)

![skills](https://img.shields.io/badge/-CSS-FF0000?style=for-the-badge&logo=css3&logoColor=white&color=indigo)

![skills](https://img.shields.io/badge/-TAILWIND_CSS-FF0000?style=for-the-badge&logo=tailwindcss&logoColor=white&color=22D3EE)

![skills](https://img.shields.io/badge/-REACT_JS-FF0000?style=for-the-badge&logo=react&logoColor=white&color=38BDF8)

![skills](https://img.shields.io/badge/-FIGMA-FF0000?style=for-the-badge&logo=figma&logoColor=white&color=red)

## ⌨️ 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](https://github.com/alli-Codes/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.