{"id":20105520,"url":"https://github.com/ideadapt/spelljack","last_synced_at":"2025-05-06T09:31:33.018Z","repository":{"id":60997985,"uuid":"540157996","full_name":"ideadapt/spelljack","owner":"ideadapt","description":"Web application to check wordpress articles and blog posts for spelling errors and manage those errors in one place","archived":false,"fork":false,"pushed_at":"2022-11-12T17:02:01.000Z","size":5897,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-03-22T10:55:14.235Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ideadapt.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-22T20:27:02.000Z","updated_at":"2023-03-15T22:57:11.000Z","dependencies_parsed_at":"2022-10-08T03:36:43.926Z","dependency_job_id":null,"html_url":"https://github.com/ideadapt/spelljack","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideadapt%2Fspelljack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideadapt%2Fspelljack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideadapt%2Fspelljack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideadapt%2Fspelljack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ideadapt","download_url":"https://codeload.github.com/ideadapt/spelljack/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224499245,"owners_count":17321596,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T17:47:17.073Z","updated_at":"2025-05-06T09:31:33.011Z","avatar_url":"https://github.com/ideadapt.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spelljack\n\nEver wanted to comfortably check multiple articles for spelling errors and manage those errors in one palace?\n\n\u003cimg src=\"https://github.com/ideadapt/spelljack/raw/main/doc/spelljack.png\" width=\"300\"\u003e\n\n# Setup\n\n[![Node.js CI](https://github.com/ideadapt/spelljack/actions/workflows/test.yml/badge.svg)](https://github.com/ideadapt/spelljack/actions/workflows/test.yml)\n\nYou must have Node \u003e= 19 and Deno \u003e= 2 installed on your machine.\n\n1. Generate a GitHub access token with gist scope: https://github.com/settings/tokens/new?scopes=gist.\n   Set it in server env config `gh_gist_token`.\n1. Create a secret gist with any file in it. Set its id in frontend env config `gist_id`.\n1. Set TextGears API key in server env config `key`. Set other textgears properties: \n   `dict_name` (only [a-z_-], server and frontend config), `dict_title` (frontend config)\n1. 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.\n1. Set the `sitemap_urls` in frontend config.\n1. If required, define `urlToTitle` in frontend config.\n1. If required, define `urlFilter` in frontend config.\n\n## Dev\n\n1. Start server `npm run server:dev`\n1. Start frontend `npm run dev`\n\n## Prod\n\n1. Only once: Set up a denoland project that connects to your repository. \n1. Only once: Add environment variables defined locally in server env config in denoland project settings.\n1. Every time you push, the denoland project is deployed automagically.\n1. Set frontend config `proxy_root` to endpoint of deployed server, e.g. https://ideadapt-spelljack.deno.dev\n1. Build frontend project for prod usage: `npm run dist`\n1. Deploy dist directory to any static web host. E.g. `rsync -vh --recursive --delete dist/*.* cyon:~/www/spelljack`\n\n## Docker / Podman\n\nUse docker to create an image that exposes one port, that serves the static files as well as the API (no cors curse no more).\n\n```\nnpm run docker:build\n\n# now run with e.g.:\ndocker run --name spelljack --rm --env-file=server/.env -p3000:3000 ideadapt/spelljack:1.0.0\n```\n\n\n# What's Inside\n\n## Features\n\n- Load articles from sitemaps\n- Scan articles for spelling errors\n- Manage spelling errors: add word to dictionary, automatically mark error as fixed on article rescan\n- Show articles containing selected misspelled words\n- Show misspelled words of selected articles\n- Show context of misspelled word (e.g. the surrounding words)\n- Jump to article edit page\n- Ignore spelling error if it refers to a correctly spelled english word (Currently only german is supported as primary article language)\n- Write operations protected via user provided password (see editor_password)\n\n## Technology\n\n- Deno based API server using oak\n- Alpine.js for DOM manipulation based on application state\n- Tailwind CSS for fuzzy feeling\n- Parcel for frontend dev and prod build\n- TextGears API for spell checking\n- GitHub gist API for storage\n- Some SVG\n- Docker for all in one deployment\n- Support for GitHub dev container\n\n\n# What more / TODO?\n\n- Support multiple editor_passwords (e.g. one per author / role)\n- Support article sources other than wordpress blog posts\n- Some better UX here and there","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideadapt%2Fspelljack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fideadapt%2Fspelljack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideadapt%2Fspelljack/lists"}