GitHub Issue Viewer

This is a React app that allows users to browse any outstanding issues (open/closed) as well as pull requests.

Contributor

Mike Choi - Developer

A.Z. - Design

Getting Started

To get this project running on your local machine, follow the instructions below.

Prerequisites

NPM

1. Download and install Node.js and npm
   (Or run the following command in your Node CLI to get the latest version of NPM if already installed)

npm install npm@latest -g

Download and Install Project Files

1. Clone the repo

git clone https://github.com/mikec-git/Github-Issue-Viewer.git

2. Run npm install inside the project root directory to get required dependencies

npm install

3. Start the server

npm run start

Enjoy! :)

Built Using

Libraries

• React.js - The Javascript library used
• React Router - Router used alongside React
• Redux - State management
• Redux-Thunk - Redux middleware for side effects
• SASS/SCSS - CSS Pre-Processor
• React Transition Group - Animations for components
• Axios - XMLHttpRequest Library
• Query String - Library to make parsing URL query strings easier

APIs

• GitHub Issue API - Database containing issues for GitHub repos

License

This project is licensed under the MIT License - see the LICENSE file for more details