Broken-Link-Website - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #llm #golang #go #rust #nodejs #java #cli #pytorch #security #mcp

Broken-Link-Website

(★ 110)

No more broken links in old unmaintained README

File Explorer

Download Latest Version (.zip)

- rules
- - bug_report.md
  - feature_request.md
- - auto-comment-on-issue.yml
  - deploy.yml
  - pr-welcome.yml
  - react-doctor.yml
  - vitest.yml
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- pre-commit
- pre-push
- main.ts
- preview.tsx
- brokenlink-checker.postman_collection.json
- logo.svg
- README-PT-BR.md
- README-TR.md
- README-ZH-CN.md
- - api.consts.ts
  - api.ts
  - languages.ts
  - links.consts.ts
  - routes.consts.ts
  - ui.consts.ts
- - ar.json
  - be.json
  - ben.json
  - bhoj.json
  - ca.json
  - chin.json
  - cs.json
  - de.json
  - en.json
  - es.json
  - fa.json
  - fr.json
  - ger.json
  - gr.json
  - guj.json
  - he.json
  - heb.json
  - hi.json
  - hu.json
  - id.json
  - it.json
  - ja.json
  - ka.json
  - kor.json
  - languageCode.json
  - mar.json
  - ms.json
  - nl.json
  - no.json
  - or.json
  - pa.json
  - ph.json
  - pl.json
  - po.json
  - ptbr.json
  - ro.json
  - ru.json
  - sp.json
  - sv.json
  - sw.json
  - tam.json
  - tel.json
  - thai.json
  - tur.json
  - uk.json
  - ur.json
  - viet.json
- - timeutils.ts
- app.css
- App.tsx
- AppLayout.tsx
- favicon.svg
- i18.tsx
- main.tsx
- router.styles.ts
- Router.tsx
- syncDocumentLanguage.ts
- theme.ts
- vite-env.d.ts
- index.ts
- render.tsx
- Navigation.test.ts
.dockerignore
.editorconfig
.env.example
.gitignore
.npmrc
.nvmrc
.prettierrc.mjs
.stylelintignore
.stylelintrc.json
.yarnrc.yml
AGENTS.md
CONTRIBUTING.md
docker-compose.yml
Dockerfile
eslint.config.js
index.html
LICENSE
nginx.conf
package.json
playwright.config.ts
pnpm-lock.yaml
postcss.config.cjs
README.md
tsconfig.json
vite.config.mjs
vitest.setup.mjs

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<a id="top-btn"></a>

# Deadlink-Hunter-Website🕵️

[![GitHub Stars](https://img.shields.io/github/stars/Deadlink-Hunter/Broken-Link-Website?style=social)](https://github.com/Deadlink-Hunter/Broken-Link-Website/stargazers)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Deployment](https://github.com/Deadlink-Hunter/Broken-Link-Website/actions/workflows/deploy.yml/badge.svg)](https://github.com/Deadlink-Hunter/Broken-Link-Website/actions/workflows/deploy.yml)

## Prefer a different language?

This README is available in multiple languages.
Click below to switch:

- 🇨🇳 [简体中文 (Simplified Chinese)](readmes/README-ZH-CN.md)
- 🇧🇷 [Português Brasileiro](readmes/README-PT-BR.md)

Deadlink-Hunter is an open-source project designed to find broken links in GitHub repositories (with future support for other platforms).
The goal is to help maintainers keep their documentation clean, reliable, and frustration-free for readers.

Deadlink Hunter Website is the frontend of the website.

You can also check [Broken-Link-Checker](https://github.com/Deadlink-Hunter/Broken-Link-Checker), this is the backend of the project that checks if a link is broken or not.
Additionally, check out [Deadlink-Crawler](https://github.com/Deadlink-Hunter/Deadlink-crawler), a new repository for crawling and analyzing links efficiently.

The project was inspired as a way to give back to the open source community, everyone is welcome.

This is the general design desired for the website, generated by Lovable, just to provide inspiration.

<img style="object-fit: contain;" width="1600" height="650" alt="image" src="https://github.com/user-attachments/assets/6cd143f2-40ec-4b9f-8f99-92d82d1e05c2" />

You can see the deployed website here: [Deadlink-Hunter Website](https://deadlink-hunter.github.io/Broken-Link-Website/)

You can check the [more elaborated ui](https://link-guard-191fc128.base44.app) that was created with base44 as initial inspiration.

<p align="left"><a href="#top-btn">Back to the top of page</a></p>

---

## ⚠️ Important Prerequisites

**Please Note:** This repository contains the **Frontend** (User Interface) of the Deadlink-Hunter project.

To fully use the scanner features, you **MUST** run the Backend server locally (or connect to a deployed instance). The frontend communicates with the backend to perform the actual link checking.

**Get the Backend here:** [Broken-Link-Checker Repository](https://github.com/Deadlink-Hunter/Broken-Link-Checker)

---

## Table of Contents

- [The Why](#the-why)
- [Contributing](#contributing)
- [Discussions](#discussions)
- [Environment Variables](#environment-variables)
- [Docker Setup](#docker-setup)
- [API & Postman Collection](#api--postman-collection)
- [Mantine Vite template](#mantine-vite-template)
- [Features](#features)
- [pnpm scripts](#pnpm-scripts)
- [Build and dev scripts](#build-and-dev-scripts)
  - [Testing scripts](#testing-scripts)
  - [Other scripts](#other-scripts)
- [Contributors](#contributors)

<p align="left"><a href="#top-btn">Go back to the top of page</a></p>

## The Why

Documentation is the first entry point for most developers exploring a project.
Yet, README files and docs often contain outdated or broken links – even in large, well-maintained repositories.

But aren’t there already broken link checkers?
There are — but most of them don’t look very good, their UIs are not user-friendly, and their broken link detection doesn’t cover all cases (for example, localhost:4000 is not actually broken).

<p align="left"><a href="#top-btn">Go back to the top of the page</a></p>

## Contributing

Contributions are welcome and greatly appreciated!

To contribute:

1.  **Fork** this repository to your own GitHub account.
2.  **Clone** your fork locally:

```bash
    git clone https://github.com/<your-username>/Broken-Link-Website.git
    cd Broken-Link-Website

```

3.  (Optional) Install pnpm package manager from this [link](https://pnpm.io/installation).
4.  Install dependencies using **pnpm** (please do not use npm or yarn):
    ```bash
    pnpm install
    ```
5.  Run this project:
    ```bash
    pnpm run dev
    ```
6.  Create a new branch for your feature or fix:
    ```bash
    git checkout -b my-feature
    ```
7.  Make your changes and commit them with clear messages.
8.  Push your branch to your fork:
    ```bash
    git push origin my-feature
    ```
9.  Create a **Pull Request** from your repository’s branch to the `main` branch of the original repository.

⚠️ Heads up: PRs that are fully AI generated and not checked by a human won’t be accepted.

<p align="left"><a href="#top-btn">Go back to the top of the page</a></p>

## Discussions

We have a Discussions page where you can share ideas, ask questions, and connect with the community:

[Discussions Page](https://github.com/Deadlink-Hunter/Broken-Link-Website/discussions)

<p align="left"><a href="#top-btn">Go back to the top of the page</a></p>

## Environment Variables

This project includes a `.env.example` file in the repository that lists the environment variables required to run the app.

**Before running the project**, create a local `.env` file based on the example.
You can copy it quickly using the command below:

```bash
# macOS / Linux
cp .env.example .env

# PowerShell
Copy-Item .env.example .env
```

### Configure Backend Connection

The `.env` file includes the variable:

- **VITE_API_BASE_URL** — the base URL for the backend API.  
  **Default:** `http://localhost:3000`

Ensure your backend server is running on this port, or update the value to match your backend configuration.

## Docker Setup

This project includes Docker support for easy deployment and development. You can run the application using Docker in two ways:

### Option 1: Using Docker Compose (Recommended)

The easiest way to run the application is using Docker Compose:

```bash
# Build and start the application
docker-compose up --build

# Or run in detached mode (background)
docker-compose up --build -d
```

The application will be available at `http://localhost`

To stop the application:

```bash
docker-compose down
```

### Option 2: Using Docker directly

You can also build and run the Docker container directly:

```bash
# Build the Docker image
docker build -t deadlink-hunter .

# Run the container
docker run -p 80:6006 deadlink-hunter
```

The application will be available at `http://localhost`

### Docker Configuration

- **Port**: The application runs on port `6006` inside the container and is mapped to port `80` on your host machine
- **Web Server**: Uses nginx to serve the built application
- **Build Process**: Multi-stage build that installs dependencies, builds the app, and serves it with nginx
- **Base Image**: Built on `node:20-alpine` for the build stage and `nginx:1.27-alpine` for the runtime

<p align="left"><a href="#top-btn">Go back to the top of the page</a></p>

## API & Postman Collection

The backend exposes a REST API for checking broken links.

We generated a Postman collection based on the internal Swagger documentation to help you test the API locally.

### 🔗 How to Use the Postman Collection

1. Open [Postman](https://www.postman.com/)
2. Click **Import**
3. Select **File** and upload:

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

> [Click here to download the file directly](./postman/brokenlink-checker.postman_collection.json)

Make sure your backend server is running at `http://localhost:3000` (or adjust the base URL in Postman if needed).

## Mantine Vite template

This project is based on the Mantine Vite template.

<p align="left"><a href="#top-btn">Go back to the top of the page</a></p>

## Features

This template comes with the following features:

- [PostCSS](https://postcss.org/) with [mantine-postcss-preset](https://mantine.dev/styles/postcss-preset)
- [TypeScript](https://www.typescriptlang.org/)
- [Storybook](https://storybook.js.org/)
- [Vitest](https://vitest.dev/) setup with [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)
- ESLint setup with [eslint-config-mantine](https://github.com/mantinedev/eslint-config-mantine)

<p align="left"><a href="#top-btn">Go back to the top of the page</a></p>

## pnpm scripts

<p align="left"><a href="#top-btn">Go back to the top of the page</a></p>

## Build and dev scripts

- `dev` – start development server
- `build` – build production version of the app
- `preview` – locally preview production build

### Testing scripts

- `typecheck` – checks TypeScript types
- `lint` – runs ESLint
- `prettier:check` – checks files with Prettier
- `vitest` – runs vitest tests
- `vitest:watch` – starts vitest watch
- `test` – runs `vitest`, `prettier:check`, `lint` and `typecheck` scripts

### Other scripts

- `storybook` – starts storybook dev server
- `storybook:build` – build production storybook bundle to `storybook-static`
- `prettier:write` – formats all files with Prettier

<p align="left"><a href="#top-btn">Go back to the top of the page</a></p>

## Contributors

Thanks to all the amazing contributors who have helped make this project better! 🎉

<a href="https://github.com/Deadlink-Hunter/Broken-Link-Website/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=Deadlink-Hunter/Broken-Link-Website" alt="Contributors" />
</a>
<p align="left"><a href="#top-btn">Go back to the top of the page</a></p>