Skip to content

A single-page mobile friendly app built with React using Github API. Wrote config files for Webpack and Babel from scratch, and set up the React app with proper testing and tooling without the use of Create-React-App.

Notifications You must be signed in to change notification settings

xinxin510/github-battle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github Battle App

A single-page mobile friendly app built with React using Github API. Wrote config files for Webpack and Babel from scratch, and set up the React app with proper testing and tooling without the use of Create-React-App.

Technologies used

Set-up and Workflow

Git Webpack Babel

Frontend Development

React JavaScript HTML5 CSS3

Description

In this app, you can discover the most popular repos for a variety of languages on GitHub in a fun/gamified experience as well as battle between two Github users to see who has a better profile.

  1. Check the top 30 popular repos for different languages, including JavaScript, Ruby, Java, CSS and Python. GitHub Battle - Homepage Refresh
  2. Click any GitHub username to visit this user's profile.
  3. Choose two GitHub users to battle and see who has the better profile. The score is calculated based on the combination of both the numbers of the profile's followers and stars. The weight of followers vs stars is 3:1. GitHub Battle - Game
  4. Toggle between light and dark theme.

GitHub Toggle

  1. Implemented custom tooltips to help users understand the information presented on each card. GitHub Tooltip

Installation

  1. Install dependencies:
npm install
  1. Get your API key from GitHub REST API
  2. Create a file named as config.js
module.exports = {
  api_token: 'YOUR_KEY_HERE'
}
  1. Run webpack in development with:
npm run start
  1. Open the project in your web browser http://localhost:8080/

About

A single-page mobile friendly app built with React using Github API. Wrote config files for Webpack and Babel from scratch, and set up the React app with proper testing and tooling without the use of Create-React-App.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published