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.
More info: https://crawler.siteone.io/
Animated GIF of the application in action - click to Play on the right when autoplay did not start or watch the commented video.
Screenshot of the form with full settings. The Basic form contains only the basic settings, and the modifications in it are written in the background to this full form. Here you can also set parameters outside the ranges offered in the basic form.
Watch the video that describes the HTML report - one of the main outputs of SiteOne Crawler.
SiteOne Crawler
.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.SiteOne-Crawler
on your desktop.This app was written over several evenings with an emphasis on useful functionality and ease of use. Both the functionality and the graphical interface were developed continuously.
The structure of the code is not optimal and the components are not ideally distributed. Sharing state between components is also not optimal.
In the next versions, refactoring will take place with the aim of better dividing the responsibilities of individual components.
If anyone is interested in helping with the development, please open an issue on GitHub. However, I would like to implement other functionalities only after the mentioned refactoring.
# 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
# run development server - it will open an Electron app with hot-reloading
$ npm run dev
Note: In the first version, I did not emphasize the treatment of all problems reported by svelte-check. Therefore, to create a build, it is necessary to remove npm run typecheck &&
from build
script in package.json
. If anyone wants to participate in the development of this GUI application, I will be happy for help and pull requests.
# NOTICE: builds have to be run on the target platform
# For Windows (x64)
$ npm run build:win-x64
# For macOS (x64)
$ npm run build:mac-x64
# For macOS (arm64)
$ npm run build:mac-arm64
# For Linux (x64)
$ npm run build:linux-x64
# For Linux (arm64)
$ npm run build:linux-arm64