Skip to content
This repository has been archived by the owner on Dec 8, 2022. It is now read-only.

mouracamila/github-explorer-project

Repository files navigation

github-explorer

GitHub Explorer

Introduction

This project was developed at RocketSeat Bootcamp 11. Its objective was to create a UI, using React and TypeScript, to consume the GitHub API.

Structuring & Technologies

API request, uses Axios HTTP client.

Navigation, uses React-router-dom. The application navigation takes advantage of the hooks useRouteMatch (these or any hooks are available React >= 16.8).

Tagged the components, to work with CSS uses Styled components.

Colors, for the hover buttons, it applies the property shade from Polished library.

Developed beyond the proposal

I implemented three new functionality:

  • Delete the repository in the list, the dashboard.
  • Delete all repositories in the list.
  • Navigate to the repository, from the repository’s details page.

Installation

  1. Clone this Repository:

 $ git clone git@github.com:mouracamila/github-explorer-project.git

  1. Installing dependencies:

$ yarn

  1. Running project:

$ yarn dev

After running yarn dev the project, in your terminal, this message should be displayed:

Compiled successfully!

You can now view github-explorer-project in the browser.

Local: http://localhost:3000

License

This project is under license from MIT.


with ❤ - MouraCamila