Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renyzeraa/github-profiler
Projeto para visualizar o usuário do github, e todos os repositórios e favoritados. Feito em Javascript, SCSS, HTML
https://github.com/renyzeraa/github-profiler
Last synced: 7 days ago
JSON representation
Projeto para visualizar o usuário do github, e todos os repositórios e favoritados. Feito em Javascript, SCSS, HTML
- Host: GitHub
- URL: https://github.com/renyzeraa/github-profiler
- Owner: renyzeraa
- Created: 2024-04-24T21:04:48.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-29T20:19:29.000Z (8 months ago)
- Last Synced: 2024-04-29T23:00:06.252Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 717 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Profiler 😺
## Introdução
Este projeto é uma aplicação web que permite aos usuários pesquisar por um nome de usuário do GitHub e exibir informações sobre os repositórios do usuário e seus favoritos, bem como detalhes adicionais e imagens do perfil do GitHub. Além disso, os repositórios são apresentados em forma de Cards, e há filtros para facilitar a navegação pelos resultados.
## Funcionalidades Principais
1. Modal Inicial:
> O modal inicial solicita ao usuário que insira o nome de usuário do GitHub.
> Possui um campo de entrada para o nome de usuário e um botão para enviar a consulta.
2. Página de Resultados:
> Após inserir o nome do usuário correto, a aplicação exibe uma página com todos os repositórios do usuário e seus repositórios favoritos.
> Os repositórios são apresentados em forma de cartões, com informações como nome do repositório, descrição, linguagem, etc.
3. Informações do Perfil:
> Na lateral direita da página de resultados, são exibidas informações e imagens do perfil do GitHub do usuário pesquisado.
> As informações podem incluir o nome do usuário, a bio, a foto do perfil, o número de seguidores, etc.
4. Filtros:
> Acima dos cartões de repositórios, existe uma área de filtros.
> Somente é possível pesquisar pelo título e descrição através de um tablet ou computador
> No campo de pesquisa basta inserir o nome do repositório que deseja e clicar enter!
5. Os filtros disponíveis incluem:
> Favoritado/Repositório do Usuário: permite filtrar entre os repositórios favoritos e os repositórios do próprio usuário.
> Linguagem: permite filtrar os repositórios pela linguagem de programação.
> Tipo de Repositório: permite filtrar os repositórios pelo tipo (por exemplo, fontes, forks, arquivados, etc.).
## Instalação e Uso
1. Primeiro, você precisa obter o URL do repositório ''https://github.com/renyzeraa/github-profiler.git''
2. Abra o terminal/powershell ou a linha de comando no seu sistema operacional. Você pode encontrar o terminal em diferentes locais, dependendo do seu sistema operacional
3. Use o comando cd (change directory) para navegar até o diretório onde deseja clonar o repositório. Por exemplo:
```
cd pasta/de/destino
```
Substitua pasta/de/destino pelo caminho do diretório onde deseja colocar o projeto clonado.
4. Agora, você pode usar o comando git clone seguido pelo URL do repositório que você copiou anteriormente. Por exemplo:
```
git clone https://github.com/usuario/github-profiler.git
```
5. Depois que o comando git clone for concluído, o projeto será clonado para o diretório de destino que você especificou. Você pode verificar isso navegando até o diretório do projeto clonado usando o comando cd e, em seguida, listar o conteúdo do diretório usando o comando ls (no MacOS e Linux) ou dir (no Windows).
6. Abrindo o projeto no vscode, inicialize ele com a extensão LiveServer (caso não tenha, basta ir na aba extensões e baixar, ou acesse https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer, baixe e instale via vsix)
6.1. Caso não saiba, no rodapé do vscode possui um ícone com nome "Go Live", este inicia o live server e ira iniciar o projeto.
## Contribuindo
Se você deseja contribuir para este projeto, siga estas etapas:
1. Faça um fork do repositório.
2. Crie um branch para sua nova funcionalidade (git checkout -b feature/nova-funcionalidade).
3. Faça commit de suas alterações (git commit -am 'Adicionando nova funcionalidade').
4. Faça push para o branch (git push origin feature/nova-funcionalidade).
5. Crie um novo Pull Request e irei analisar !.
#### [**Renan Leandro da Silva**](https://github.com/renyzeraa)
🛠 `Frontend` Developer Jr.
💼 IPM Sistemas
📍 Santa Catarina - Brazil
