Skip to content

A web app that consumes the github API to explore repositories(issues, stars, etc)

Notifications You must be signed in to change notification settings

paichato/git-explorer

Repository files navigation

GIT-EXPLORER

A web app that consumes the github API to explore repositories(issues, stars,etc).

What the app looks like

banner banner

How to run the app

  1. Either click on the link on the right panel or fork/download the app and open the folder in the CLI
  2. Install all dependecies using the 'yarn add' command
  3. Start the web server using the 'yarn start'. The app will be served at http://localhost:3000/git-explorer
  4. Go to http://localhost:3000/git-explorer on your browser and start exploring repos

How to explore

  1. Click on the text box on the center of the page
  2. Type out a repository name, like facebook/react
  3. Submit the repo search by clicking the search green button on the right

User stories

  • A user can search for a repo
  • A user can see issues from a repo
  • A user can

Features

  • Search for a repo
  • A search returns:
    1. the repo owner profile picture;
    2. the repo name and;
    3. repo description
  • Clicking on a repo
    • See repo details like:
      1. stars,
      2. forks,
      3. open issues

Dependecies

react styled-components axios
polished react-router-dom react-icons

Why

This project is part of my personall portfolio. It was built based on @rocketseat module but on ReactJS version.

Email: [email protected] Contact me at Linkedin
:

UI/UX credits: @rocketseat.

Future Features

  • Light/Dark Theme

Buy Me a Coffee at ko-fi.com |

About

A web app that consumes the github API to explore repositories(issues, stars, etc)

Topics

Resources

Stars

Watchers

Forks