An open API service indexing awesome lists of open source software.

https://github.com/sanchitbajaj02/github-finder

A dynamic github finder using react js and github apis
https://github.com/sanchitbajaj02/github-finder

github-api hacktober hacktoberfest react reactjs readme statistics

Last synced: 8 months ago
JSON representation

A dynamic github finder using react js and github apis

Awesome Lists containing this project

README

          

# GitHub Finder: Your Gateway to Dynamic GitHub Statistics!

## ⚑ Project Status

[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103?color=greendark)](https://github.com/Sanchitbajaj02/GitHub-Finder)
[![Contributers](https://img.shields.io/github/contributors/Sanchitbajaj02/GitHub-Finder?color=greendark)](https://github.com/Sanchitbajaj02/GitHub-Finder/graphs/contributors)
[![license MIT](https://img.shields.io/github/license/Sanchitbajaj02/GitHub-Finder?color=greendark)](https://github.com/Sanchitbajaj02/GitHub-Finder/blob/master/LICENSE)
[![Issues](https://img.shields.io/github/issues/Sanchitbajaj02/GitHub-Finder?color=greendark&logo=github)](https://github.com/Sanchitbajaj02/GitHub-Finder/issues)
[![Forks](https://img.shields.io/github/forks/Sanchitbajaj02/GitHub-Finder?color=greendark&logo=github)](https://github.com/Sanchitbajaj02/GitHub-Finder/network/members)
[![Pull Requests](https://img.shields.io/github/issues-pr/Sanchitbajaj02/GitHub-Finder?color=greendark)](https://github.com/Sanchitbajaj02/GitHub-Finder/issues)
[![Stars](https://img.shields.io/github/stars/Sanchitbajaj02/GitHub-Finder?color=greendark)](https://github.com/Sanchitbajaj02/GitHub-Finder/stargazers)
![GitHub repo size](https://img.shields.io/github/repo-size/Sanchitbajaj02/GitHub-Finder?color=greendark)

## πŸ€” Why open source

Contributing in open source increases your opportunities to work with different projects and mentors, getting to know various insights and ideas. It is a platform where contributors grow together with a construvtive and a positive attitude.

This repository also provides one such platforms where contributers come over and put their ideas of new games and make our website as interactive as much they can!

## πŸ’» Tech Stack

- JavaScript
- React.js
- Context API
- Axios
- GitHub APIs

## πŸ‘‹ Introduction

GitHub Finder is a web application that helps users retrieve information about their GitHub statistics, which dynamically change with their profile activity.

## πŸ”¨ What does it do?

Github finder contains a search feature that searches for all the Github users using the text entered by the user. It displays the users whose username fully or partially matches with the entered text.
This GitHub Finder differs from others in the sense that, it not only shows the basic information of that GitHub user account but also shows their activities, contributions, commits, pull requests and overall profile score.

## πŸ›‘οΈ License

Palettegram is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## πŸ€” How to contribute ?

Contributing to open-source software (OSS) projects can be a rewarding and fulfilling experience. Not only can you learn new skills, but you can also help make a valuable contribution to a project that benefits the broader community

- Remember to read [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.

- Read the [Git Workflow](docs/git.md) to follow best practices.

- Follow the [Contribution Guidelines](CONTRIBUTING.md).

- Create an [issue](https://github.com/Sanchitbajaj02/GitHub-Finder/issues) to report bugs, and vulnerabilities or add a new feature.

- Remember to add a good commit message.

- Don't spam if you do it your PR/issue will be closed.

## πŸ“– Setup

Follow the steps by [clicking the link here](docs/setup.md) to setup the project into your local machine.

## πŸ™πŸ½ Support

This project needs a star️ from you. Don't forget to leave a star 🌟