🧭 Discover new Horizons 🧭

Projeto   |    Tecnologias   |    Dependências   |    Clonagem e Debug   |    Desenvolvedor

💻 Projeto

O github-explorer consiste em uma aplicação que lista repositórios diretamente do GitHub. Ao entrar na aplicação, o usuário pode adicionar um repositório inserindo a url do mesmo ou navegar entre os repositórios já adicionados. Ademais disso, é possível visualizar as Issues, Stars e Forks de um repositório. Todos os repositórios são armazenados utilizando local storage e alimentados diretamenta da API do GitHub

👾 Tecnologias

Foram utilizadas as seguintes tecnologias para o desenvolvimento do projeto

• React

  A declarative, efficient, and flexible JavaScript library for building user interfaces. https://reactjs.org

🛠 Dependências

Foram utilizadas as seguintes dependências para o desenvolvimento do projeto

• axios @0.19.2;

  Promise based HTTP client for the browser and node.js

• react @16.13.1;

  A JavaScript library for building user interfaces

• react-router-dom @5.1.2;

  DOM bindings for React Router.

• react-icons @3.10.0;

  Include popular icons in your React projects easily with react-icons, which utilizes ES6 imports that allows you to include only the icons that your project is using.

• styled-components @5.1.0;

  Use the best bits of ES6 and CSS to style your apps without stress 💅.

• polished @3.5.2;

  A lightweight toolset for writing styles in JavaScript.

👷‍♂️ Clonagem e debug

• Para clonar este repositório é necessário ter instalado o Git, caso não tenha, poderá instalar através deste tutorial
• Com o Git já configurado, execute o seguinte comando git clone https://github.com/leandrosouzaa/github-explorer.git
• Aguarde o término da execução deste comando. Após a clonagem será criada uma pasta chamada github-explorer contendo a aplicação.
• Antes de executar o projeto é necessário instalar as dependências contidas no arquivo package.json, para isso, acesse a pasta frontend dentro da raíz do projeto através do seguinte comando cd github-explorer/frontend e em seguida execute yarn para instalar as dependências.
• Após a conclusão da instalação, execute o script de inicio através do comando yarn start.
• Será iniciado uma nova aba em seu navegador no endereço http://localhost:3000. Caso não abra, digite o endereço citado em seu navegador e aguarde.
• Para acessar o mobile da aplicação é necessário estar conenctado na mesma rede em que seu servidor local está rodando. Tendo isso em vista, descubra o IP local de sua máquina na rede e digite no navegador do seu celular o endereço de seu computador seguido pela porta utilizada pelo projeto. Ex: Se o meu IP local é 192.168.0.106, terei que digitar o o seguinte endereço em meu celular: http://192.168.0.106:3000.
• Caso tenha alguma dúvida, sinta-se confortável para abrir uma issue no repositório.
• O projeto irá executar em versão de desenvolvimento.

👨‍💻 Desenvolvedor

Leandro Souza Futuro Cientista da Computação pelo Instituto Federal de Educação, Ciência e Tecnologia de São Paulo. @leandrosouzaa

Feito com 🖤 por Leandro Souza