Skip to content

rajat2502/GitHub-Battle

Repository files navigation

GitHub-Battle

A Web-App that lists 30 of the most popular repositories of a language (overall also). It also lets you battle between any two GitHub users.

How to use?

Open Github Battle in any browser of your choice. After the landing page pops on the screen, under the "Popular" category, you can see different header sections for most commonly used programming languages like for Javascript, Python, Java, Ruby etc. The default option among them will be set to all, but you can hover over any of them and choose one, which will redirect you to the default github repository page of the selected one. Moreover, the more exciting part of Github-Battle is the Battle section which can be located just beside the "Popular" category on the top left corner of the screen. User(s) can enter their Github usernames of any choice under the player section and then click on submit. Upon submit, the two entered names will automatically be assigned to their default github avatars and then battle starts (for invalid github username, invalid avatars will be assigned). Fraction of seconds later, the winner name is displayed on the screen along with name, score, address, address, followers, following as well as the total number of repositories in their accounts.

Features :

1. Lists 30 of the most popular GitHub repositories in a language.
2. Battle any two GitHub users.

Technologies Used :

 * React-JS
  * React Router
  * React Hooks
  * GitHub's API
  * Netlify.com (for hosting)

How to Run Locally :

  1. Clone the Repository

    git clone https://github.com/rajat2502/GitHub-Battle

  2. cd into GitHub-Battle

    cd GitHub-Battle

  3. Install all dependencies

    npm install

  4. Start Local Server

    npm start

Snapshots:

1
2

Contributing

Want to help? Awesome! We are always thrilled to receive pull requests, and do our best to process them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it.

If your pull request is not accepted on the first try, don't be discouraged! If there's a problem with the implementation, hopefully you received feedback on what to improve.