About | Deploy | Layout | How It Works | Technologies | Author | License
O projeto GitHub Profiles consiste em uma aplicação que mostra os principais detalhes do perfil de um usuário do GitHub, além de também listar os principais repositórios (pessoas e favoritados) deste mesmo usuário.
O deploy da aplicação pode ser acessada através da seguinte URL base: https://pabloxt14-github-profiles.netlify.app/
Você pode visualizar o layout do projeto através desse link. É necessário ter conta no Figma para acessá-lo.
Veja uma demonstração visual das principais telas da aplicação:
Antes de baixar o projeto você vai precisar ter instalado na sua máquina as seguintes ferramentas:
- Git
- NodeJS
- Yarn ou NPM
- Para o banco de dados ter o PostgreSQL ou Docker para baixar a imagem do banco.
Além disto é bom ter um editor para trabalhar com o código como VSCode
Passo a passo para clonar e executar a aplicação na sua máquina:
# Clone este repositório
$ git clone git@github.com:pabloxt14/github-profiles.git
# Acesse a pasta do projeto no terminal
$ cd github-profiles
# Instale as dependências
$ npm install
# Execute a aplicação em modo de desenvolvimento
$ npm run dev
# A aplicação inciará em alguma porta disponível que poderá ser acessada pelo navegadorAs seguintes principais ferramentas foram usadas na construção do projeto:
Para mais detalhes das dependências gerais da aplicação veja o arquivo package.json
Este projeto está sob a licença MIT. Consulte o arquivo LICENSE para mais informações
Feito com 💜 por Pablo Alan 👋🏽 Entre em contato!