https://github.com/2naive/website-checker
Modular site audit tool for checking SEO, performance, quality and other metrics.
https://github.com/2naive/website-checker
Last synced: about 1 year ago
JSON representation
Modular site audit tool for checking SEO, performance, quality and other metrics.
- Host: GitHub
- URL: https://github.com/2naive/website-checker
- Owner: 2naive
- Created: 2025-03-31T23:40:16.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-01T00:18:54.000Z (about 1 year ago)
- Last Synced: 2025-04-01T00:28:45.181Z (about 1 year ago)
- Language: JavaScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Audit: audit_results.json
Awesome Lists containing this project
README
# 🌐 Website Checker
[](LICENSE)
[](https://codecov.io/gh/2naive/website-checker)
> A modular, easily extendable website auditing tool built with Node.js. It provides detailed insights into SEO, performance, accessibility, content quality, and more.
---
## 🚀 Overview
**Website Checker** helps developers, SEO specialists, and website owners quickly evaluate websites. It provides modular checks covering SEO, HTML validation, performance metrics, spelling errors, structured data validation, and much more.
- ✅ **SEO Checks**: Robots.txt, sitemap.xml, meta tags, structured data, headings, broken links.
- 🚀 **Performance Checks**: Response times, Lighthouse performance scores.
- 📖 **Content Checks**: Spellchecking, headings validation.
- 📑 **Markup Checks**: HTML validation via W3C standards.
- 🔄 **Flexible and modular**: Easily add your own custom checks.
---
## 📦 Installation
### Prerequisites
- Node.js 18+ ([download here](https://nodejs.org))
### Clone repository:
```bash
git clone https://github.com/yourusername/website-checker.git
cd website-checker
npm install
```
---
## ⚙️ Usage
### Run audit from CLI
```bash
npm run audit https://example.com -- [options]
```
### Run as web service in your browser
```bash
npm run server
```
### Options:
- `-c, --config `: Use a custom config file (default: `./config.json`)
- `-j, --json `: Save results to a JSON file
- `-i, --include `: Comma-separated list of checks or groups to include (runs only specified checks/groups)
- `-e, --exclude `: Comma-separated list of checks or groups to exclude
- `-d, --depth `: Depth of child pages to audit (default: 0, audits only the specified URL)
### Example
```bash
npm run audit https://example.com -- -e lighthousePerformance -d 2 -j results.json
```
---
## 🛠️ Available Checks
| Category | Checks |
|---------------|-------------------------------------|
| **SEO** | Robots.txt, Sitemap, Title length, Meta tags, Structured data, Broken links, Headings, Duplicate URLs |
| **Performance** | Response Time, Lighthouse Scores |
| **Content** | Spellcheck |
| **Markup** | HTML Validation (via W3C) |
---
## 🧩 Adding Your Own Checks
Create a new check file in the appropriate folder inside `checks/`. Export your check as a default async function.
---
## 🧪 Testing & Coverage
Run tests:
```bash
npm test
```
Run coverage:
```bash
npm run coverage
```
Coverage report will be generated at `coverage/index.html`.
---
## 📝 Contributing
Pull requests are encouraged!
---
## 📃 License
[MIT](LICENSE) © 2naive
---
🎉 **Happy auditing!**