https://github.com/viniciusfer01/05-first-project-react

This is an app that uses GitHub's API and lets you search for profiles and repositories available on the site.
https://github.com/viniciusfer01/05-first-project-react

css css3 github html5 polished reactjs responsive-web-design rest-api typescript

Last synced: 2 months ago
JSON representation

This is an app that uses GitHub's API and lets you search for profiles and repositories available on the site.

• Host: GitHub
• URL: https://github.com/viniciusfer01/05-first-project-react
• Owner: viniciusfer01
• Created: 2020-10-18T22:21:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-10-25T19:34:50.000Z (over 5 years ago)
• Last Synced: 2025-03-22T08:48:09.658Z (over 1 year ago)
• Topics: css, css3, github, html5, polished, reactjs, responsive-web-design, rest-api, typescript
• Language: TypeScript
• Homepage: git-hub-explorer-git-master.viniciusfer01.vercel.app
• Size: 506 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# GitHub Explorer

This is an app that uses GitHub's API and lets you search for repositories available on the site. It also stores them in a local cache on your browser and lets you see the issues, stars and forks of the repository you click.

### Tools used

- React

- Typescript

### Results

_Home Page_ ![GitHub Explorer Home Page](/src/assets/Home.png)

_Dashboard_ ![GitHub Explorer Dashboard](/src/assets/Dashboard.png)

## Want to check it out?

Access [This Link](https://git-hub-explorer-sooty.vercel.app/) to test the app deployed in [Vercel](https://vercel.com/).

Then, you can search for any public repository from GitHub by simply typing the name of the profile followed by a dash and the name of the repository (example: profile/repository).

You can also click on a repository to see more details about it.

### Things to do

- [x] Search for a repository on GitHub

- [x] List the repositories 

- [x] Once clicked, show more details about the repository (its issues, stars and forks)

### How to run it?

1. `git clone https://github.com/viniciusfer01/05-first-project-react.git`

2. `cd 05-first-project-react`

3. `yarn`

4. `yarn start`