README.md

This project is divided in 2 parts, WEB and MOBILE.

The idea is to make easier to explore github repositories, so you can just type a repository name (the format must be "user/repositoryname") and it will be add to your "dashboard". You will be able to click on any item of this list and access the repo info, like stars, forks, etc. Later you can come back and your list will still be there, since all is storaged on your local storage. You can see the website and mobile app working just following the GETTING STARTED section.

WEB

Technologies

• React
• Typescript
• React Router DOM
• React Icons
• Styled Components
• Axios

MOBILE

Technologies

• React Native
• Typescript
• React Navigation
• React Native Community Async Storage
• React Native Vector Icons
• Styled Components
• Axios

GETTING STARTED

Requirements

• Yarn or npm
• git
• React Native development environment

Clone the project and access the folder

$ git clone https://github.com/DanielMesquitta/githubexplorer && cd githubexplorer

Start web

Inside the the root directory

# Go to web folder
$ cd web

# Install the dependencies
$ yarn

# Start
$ yarn start

Start mobile

Inside the the root directory

# Go to mobile folder
$ cd mobile

# Install the dependencies
$ yarn

# Run this if you will emulate on an android
$ yarn android

# Run this if you will emulate on an ios
$ yarn ios

# Start the app
$ yarn start