alangeek / github_explorer Goto Github PK

• About
• Getting Started
• Usage
• Built Using
• Contributing
• Authors
• Acknowledgments

Single page application ( SPA ) built with ReactJS and TypeScript to explore GitHub repositories. This project enables you to save and list repositories and offers an easy way to access the repository issues page.

It was built as an exercise of Rocketseat's GoStack Bootcamp to put in practice the studies of ReactJS, React Hooks, Styled Components, React Router Dom, responsive layout and GitHub Pages for deploy.

This project connects to GitHub official API to get the data.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

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

NodeJS
NodeJS

A JavaScript package manager like NPM or Yarn
Node.js Yarn

Git installed in your machine (Mac and Linux already has Git installed by default)
Download Git to your SO

# open your terminal/cmd and clone this repository

git clone  https://github.com/alangeek/Github_Explorer.git

# access folder Github_Explorer

cd Github_Explorer

# install dependencies using your favorite package manager

yarn
# or with NPM usign npm install
npm install

# run app typing

yarn start
#or with NPM
npm run start

# The app should open on "http://localhost:3000" 🎉🎉🎉

🚧 Comming soon...

It is very simple to use this application:

1. just type inside the input: owner/repository that you want to add to your list. Example:

 facebook/react

 # facebook: owner of repository
 # react: repository name

2. Now just click on the repository that you added to see details

• ReactJS - UI library
• TypeScript - Static Type Checking
• Styled Components - CSS in JS library
• Axios - Http requests
• React Router DOM - Navigation
• React Icons - Svg Icons library

• @alangeek
• Feel free to send me feedbacks on Linkedin

See also the list of contributors who participated in this project.

• RocketSeat Team
• Diego Fernandes, CTO at Rocketseat