Siteone Crawler GUI

Abstract

1. Introduction

This is a desktop application to very useful command-line tool SiteOne Crawler (watch video) and is ready for all major platforms - Windows (x64), macOS (x64, arm64) and Linux (x64, arm64).

The goal of this desktop application is to enable comfortable use of SiteOne Crawler even for users without the need to work with the command line.

Watch the video that describes the HTML report - one of the main outputs of SiteOne Crawler.

2. Objective

SiteOne Crawler GUI is a cross-platform website crawler and analyzer for SEO, security, accessibility, and performance optimization—ideal for developers, DevOps, QA engineers, and consultants. Supports Windows, macOS, and Linux (x64 and arm64).

This project demonstrates how Svelte can be applied to a real-world Digital Marketing & SEO problem.

4. Technology Stack

• Electron as a desktop app framework
• Svelte as a JS framework
• TypeScript for type checking
• Vite as a bundler
• daisyUI and Tailwind CSS for UI
• SiteOne Crawler as a command-line tool for crawling, generating reports or offline versions of websites

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• See the project README for exact requirements
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/janreges/siteone-crawler-gui.git
cd siteone-crawler-gui

1. Go to the releases section.
2. Download the latest ready version of the installer for your platform (Windows, macOS, Linux) and architecture (x64, arm64).
3. Install the application.
4. Run the installed application - you can find it in your system under the name SiteOne Crawler.
5. Enter the URL of your website.
6. Start crawling.
7. Wait for the crawling to finish.
8. On the Result tab, you can open a detailed HTML report or download the report as JSON or TXT. If you have set, you can view the generated offline version of your website or download the sitemap xml/txt files.

# checkout repository
git checkout https://github.com/janreges/siteone-crawler-gui.git
cd siteone-crawler-gui

# initialize and download submodule with command-line SiteOne Crawler into src/siteone-crawler
git submodule update --init --recursive

# install dependencies
npm install

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Export reports to Google Sheets or PDF
• Schedule weekly automated reports
• Add competitor comparison

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Which marketing or SEO problem does this tool solve?
2. Which data sources or APIs does it use (Search Console, Analytics, social platforms)?
3. Which metrics or KPIs does it report and how are they calculated?
4. How could the output help a business make decisions?
5. How would you schedule it to run automatically?

9. Source Code & License

This project is developed by janreges and published on GitHub under the MIT License. Please follow the license terms and credit the original author when you use or modify this code.