Skip to content

devnunes/github-explorer

Repository files navigation

Project logo

github-explorer

Status Top languege License


Few lines describing your project.

📝 Table of Contents

🧐 About

This project is a result of one module of bootcamp GoStack, by Rocketseat. Allows the user to search repositories on the public API of Github and see how many stars, forks and issues the project have.

Print live

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

Installing

After you clone the repository in your machine and all the requirements are set. You should run

yarn install

And then

yarn start

The project will start on htttp://localhost:3000/. Make sure this port :3000 is available to run the project.

🎈 Usage

On the input of home page you should enter the user/repo to make a search.

⛏️ Built Using

  • ReactJs - A JavaScript library for building user interfaces.
  • Styled Components - Visual primitives for the component age.
  • TypeScript - a language for application-scale JavaScript development.

✍️ Authors

About

Discover and saves your favs repos.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published