Spelljack

Ever wanted to comfortably check multiple articles for spelling errors and manage those errors in one palace?

Setup

You must have Node >= 19 and Deno >= 2 installed on your machine.

Generate a GitHub access token with gist scope: https://github.com/settings/tokens/new?scopes=gist. Set it in server env config gh_gist_token.
Create a secret gist with any file in it. Set its id in frontend env config gist_id.
Set TextGears API key in server env config key. Set other textgears properties: dict_name (only [a-z_-], server and frontend config), dict_title (frontend config)
Set an editor_password (user is prompted to enter that, once a write operation is triggered, e.g. "Check spelling" or "ignore") in the server env config.
Set the sitemap_urls in frontend config.
If required, define urlToTitle in frontend config.
If required, define urlFilter in frontend config.

Only once: Set up a denoland project that connects to your repository.
Only once: Add environment variables defined locally in server env config in denoland project settings.
Every time you push, the denoland project is deployed automagically.
Set frontend config proxy_root to endpoint of deployed server, e.g. https://ideadapt-spelljack.deno.dev
Build frontend project for prod usage: npm run dist
Deploy dist directory to any static web host. E.g. rsync -vh --recursive --delete dist/*.* cyon:~/www/spelljack

Use docker to create an image that exposes one port, that serves the static files as well as the API (no cors curse no more).

npm run docker:build

# now run with e.g.:
docker run --name spelljack --rm --env-file=server/.env -p3000:3000 ideadapt/spelljack:1.0.0

Load articles from sitemaps
Scan articles for spelling errors
Manage spelling errors: add word to dictionary, automatically mark error as fixed on article rescan
Show articles containing selected misspelled words
Show misspelled words of selected articles
Show context of misspelled word (e.g. the surrounding words)
Jump to article edit page
Ignore spelling error if it refers to a correctly spelled english word (Currently only german is supported as primary article language)
Write operations protected via user provided password (see editor_password)