GitHub Explorer

A React app to search and list repositories from GitHub.

A study project to put into practice some skills using fundamentals of React JS.

Conceptions:

• Props
• State
• Navigate throught routes
• Restful API
• Saving data in Local Storage
• Error handling

Used technologies:

• Node | Yarn | TypeScript
• React | React-Router-Dom | React-Icons
• Axios
• Styled Components | Polished
• Design patterns
  • Editor Config
  • ESLint
  • Prettier

Installation

To the following instructions, consider that you must have Yarn installed.

Clone the repository to your local machine:

git clone git@github.com:lmourabraga/react-github-explorer.git

To install all dependencies, open the terminal on the root reposity path and run:

yarn

After the succed message, you are finnaly able to start the application by running:

yarn start

Now access http://localhost:3000 and try it out.

Usage example

Type a repository path and click on Search button. The path must be something as: username/repositoryName.

Click on a repository listed to navigate into the repository page, then you will see the numbers of stars, forks and opened issues and also a list of issues which you can click to go the GitHub issue page.

Contributing

1. Fork it (https://github.com/lmourabraga/react-github-explorer/fork)
2. Create your feature branch (git checkout -b feature/myBranch)
3. Commit your changes (git commit -am 'Add some myBranch')
4. Push to the branch (git push origin feature/myBranch)
5. Create a new Pull Request