Skip to content

README-PT-BR.md

Latest commit

 

History

History
262 lines (164 loc) · 9.54 KB

README-PT-BR.md

File metadata and controls

262 lines (164 loc) · 9.54 KB
Raw

Deadlink-Hunter-Website🕵️

GitHub Stars License: MIT Deployment

Prefere um idioma diferente?

Este README está disponível em múltiplos idiomas. Clique abaixo para alternar:

Deadlink-Hunter é um projeto open-source projetado para encontrar links quebrados em repositórios do GitHub (com suporte futuro para outras plataformas). O objetivo é ajudar mantenedores a manter sua documentação limpa, confiável e livre de frustrações para os leitores.

Deadlink Hunter Website é o frontend do site.

Você também pode conferir o Broken-Link-Checker, que é o backend do projeto responsável por verificar se um link está quebrado ou não. Além disso, confira o Deadlink-Crawler, um novo repositório para rastrear (crawl) e analisar links de forma eficiente.

O projeto foi inspirado como uma forma de retribuir à comunidade open source, e todos são bem-vindos.

Este é o design geral desejado para o site, gerado pelo Lovable, apenas para servir de inspiração.

image

Você pode conferir a interface mais elaborada que foi criada com base44 como inspiração inicial.

Voltar ao topo da página

⚠️ Pré-requisitos Importantes

Atenção: Este repositório contém o Frontend (Interface de Usuário) do projeto Deadlink-Hunter.

Para utilizar totalmente as funcionalidades de scanner, você DEVE rodar o servidor Backend localmente (ou conectar-se a uma instância implantada). O frontend se comunica com o backend para realizar a verificação real dos links.

Obtenha o Backend aqui: Repositório Broken-Link-Checker

Índice

Voltar ao topo da página

O Porquê

A documentação é o primeiro ponto de entrada para a maioria dos desenvolvedores que exploram um projeto. No entanto, arquivos README e documentações frequentemente contêm links desatualizados ou quebrados – mesmo em repositórios grandes e bem mantidos.

Mas já não existem verificadores de links quebrados? Existem — mas a maioria deles não tem uma boa aparência, suas interfaces (UIs) não são amigáveis ao usuário, e a detecção de links quebrados não cobre todos os casos (por exemplo, localhost:4000 não é realmente quebrado).

Voltar ao topo da página

Contribuindo

Contribuições são bem-vindas e muito apreciadas!

Para contribuir:

  1. Faça um Fork deste repositório para sua própria conta GitHub.

  2. Faça um Clone do seu fork localmente:

    git clone https://github.com/<seu-usuario>/Broken-Link-Website.git
cd Broken-Link-Website

  3. (Opcional) Instale o gerenciador de pacotes pnpm através deste link.

  4. Instale as dependências usando pnpm (por favor, não use npm ou yarn):

    pnpm install

  5. Rode este projeto:

    pnpm run dev

  6. Crie uma nova branch para sua feature ou correção:

    git checkout -b minha-feature

  7. Faça suas alterações e realize o commit com mensagens claras.

  8. Faça o Push da sua branch para o seu fork:

    git push origin minha-feature

  9. Crie um Pull Request da branch do seu repositório para a branch main do repositório original.

⚠️ Atenção: PRs que sejam totalmente gerados por IA e não verificados por um humano não serão aceitos.

Voltar ao topo da página

Environment Variables

Este projeto inclui um arquivo .env.example no repositório que lista as variáveis de ambiente (environment variables) necessárias para rodar o app.

Antes de rodar o projeto, crie um arquivo local .env baseado no exemplo. Você pode copiá-lo rapidamente usando o comando abaixo:

# macOS / Linux
cp .env.example .env

# PowerShell
Copy-Item .env.example .env

Configurar Conexão com Backend

O arquivo .env inclui a variável:

  • VITE_API_BASE_URL — a URL base para a API backend.
    Padrão: http://localhost:3000

Certifique-se de que seu servidor backend esteja rodando nesta porta, ou atualize o valor para corresponder à sua configuração de backend.

Configuração Docker

Este projeto inclui suporte a Docker para facilitar o deployment e desenvolvimento. Você pode rodar a aplicação usando Docker de duas maneiras:

Opção 1: Usando Docker Compose (Recomendado)

A maneira mais fácil de rodar a aplicação é usando Docker Compose:

# Buildar e iniciar a aplicação
docker-compose up --build

# Ou rodar em modo detached (segundo plano)
docker-compose up --build -d

A aplicação estará disponível em http://localhost

Para parar a aplicação:

docker-compose down

Opção 2: Usando Docker diretamente

Você também pode buildar e rodar o container Docker diretamente:

# Buildar a imagem Docker
docker build -t deadlink-hunter .

# Rodar o container
docker run -p 80:6006 deadlink-hunter

A aplicação estará disponível em http://localhost

Configuração Docker

  • Porta: A aplicação roda na porta 6006 dentro do container e é mapeada para a porta 80 na sua máquina host
  • Servidor Web: Usa nginx para servir a aplicação buildada
  • Processo de Build: Build multi-stage que instala dependências, builda o app, e o serve com nginx
  • Imagem Base: Construída sobre node:20-alpine para o estágio de build e nginx:1.27-alpine para o runtime

Voltar ao topo da página

API & Postman Collection

O backend expõe uma API REST para verificação de links quebrados.

Geramos uma coleção Postman baseada na documentação interna Swagger para ajudar você a testar a API localmente.

🔗 Como Usar a Postman Collection

  1. Abra o Postman

  2. Clique em Import

  3. Selecione File e faça o upload de:

    ./postman/broken-link-checker.postman_collection.json

Clique aqui para baixar o arquivo diretamente

Certifique-se de que seu servidor backend esteja rodando em http://localhost:3000 (ou ajuste a URL base no Postman se necessário).

Template Mantine Vite

Este projeto é baseado no template Mantine Vite.

Voltar ao topo da página

Funcionalidades

Este template vem com as seguintes funcionalidades:

Voltar ao topo da página

Scripts pnpm

Voltar ao topo da página

Scripts de Build e Dev

  • dev – inicia servidor de desenvolvimento
  • build – builda a versão de produção do app
  • preview – pré-visualiza localmente o build de produção

Scripts de Teste

  • typecheck – verifica tipos TypeScript
  • lint – roda ESLint
  • prettier:check – verifica arquivos com Prettier
  • vitest – roda testes vitest
  • vitest:watch – inicia watch do vitest
  • test – roda os scripts vitest, prettier:check, lint e typecheck

Outros Scripts

  • storybook – inicia servidor de desenvolvimento storybook
  • storybook:build – builda bundle de produção do storybook para storybook-static
  • prettier:write – formata todos os arquivos com Prettier

Voltar ao topo da página

Contribuidores

Obrigado a todos os incríveis contribuidores que ajudaram a tornar este projeto melhor! 🎉

Contributors

Voltar ao topo da página