Github Explorer is a project that uses API from GitHub to create a mini organized list of repositories and their issues.

The idea of this mini project is just to boost my abilities with React.js, Typescript, and Styled Components.

Features

• Add a repository from GitHub (example: 'facebook/react') and see their issues.
• Pagination of the issues with Back and Next buttons.

Summary

• Technology
  • Application
• How to run
  • Web

🚀 Technology

💻 Application

The application was developed with Typescript using the framework ReactJS and Styled-Components for visual proposes.

I'm using Github API to collect all the information about the repository and their issues.

---

💥 How to run

• Prerequisites

  • It's necessary to have Node.js installed on the computer
  • It's necessary to have Git installed and configured on the computer
  • Also, it's necessary to have a package manager either NPM or Yarn.

Clone the repository:

  $ git clone https://github.com/paulo-carvalho93/github-explorer.git

💻 Web

  # API
  $ cd github-explorer
  # Installing project dependencies.
  $ yarn # or npm install

  # Start Web Project
  $ yarn start # or npm start

  # Do you want to publish ?
  $ yarn build # or npm build
  # Static files for web will be saved in the `public` folder