💻 Sobre o projeto

🔎 Github Explorer - é uma aplicação para pesquisar repositórios do github de maneira rápida.

🎨 Layout

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• React
• TypeScript
• Styled Components

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
Git, Node.js, Yarn.
Além disto é bom ter um editor para trabalhar com o código como VSCode

🧭 Rodando a aplicação

# Clone este repositório
$ git clone https://github.com/pedroksty/github-explorer.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd github-explorer

# Instale as dependências
$ yarn

# Execute a aplicação em modo de desenvolvimento
$ yarn start

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000

😯 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

   Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Pedro henrique 👋🏽 Entre em contato!