github-repo-leaderboard

This is a simple web application that will display the "top committers in past week" leaderboard for a given GitHub repository. It uses the GitHub Commits API to achieve its functionality.

It is built using:

• ES2015
• React.js
• redux
• webpack
• bootstrap 4 (alpha)

Project Specification

Getting Started

Be sure you've read the instructions for contributing.

1. Clone the repository.

2. Set your NODE_ENV environment variable:

    $ export NODE_ENV=development
   

3. Create your .env file for your environment, e.g.:

    PORT=9090
    APP_BASEURL=http://localhost:9090
    GITHUB_API_TOKEN=<a valid GitHub API token>
   

4. Launch flootty to share your terminal:

    $ flootty -c --unsafe --url=https://floobits.com/prattsj/github-leaderboard term1
   

5. Run the server:

    $ npm install
    $ npm start
   

6. Visit the server in your browser:

    $ open http://localhost:9090
   

License

See the LICENSE file.