https://github.com/ideadapt/spelljack

Web application to check wordpress articles and blog posts for spelling errors and manage those errors in one place
https://github.com/ideadapt/spelljack

Last synced: 3 days ago
JSON representation

Web application to check wordpress articles and blog posts for spelling errors and manage those errors in one place

• Host: GitHub
• URL: https://github.com/ideadapt/spelljack
• Owner: ideadapt
• Created: 2022-09-22T20:27:02.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-12T17:02:01.000Z (about 2 years ago)
• Last Synced: 2023-03-22T10:55:14.235Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 5.62 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Spelljack

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



# Setup

[![Node.js CI](https://github.com/ideadapt/spelljack/actions/workflows/test.yml/badge.svg)](https://github.com/ideadapt/spelljack/actions/workflows/test.yml)

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

1. 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`.

1. Create a secret gist with any file in it. Set its id in server env config `gist_id`.

1. 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)

1. 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.

1. Set the `sitemap_urls` in frontend config.

1. If required, define `urlToTitle` in frontend config.

1. If required, define `urlFilter` in frontend config.

## Dev

1. Start server `npm run server:dev`

1. Start frontend `npm run dev`

## Prod

1. Only once: Set up a denoland project that connects to your repository. 

1. Only once: Add environment variables defined locally in server env confing in denoland project settings.

1. Every time you push, the denoland project is deployed automagically.

1. Set frontend config `proxy_root` to endpoint of deployed server, e.g. https://ideadapt-spelljack.deno.dev

1. Build frontend project for prod usage: `npm run dist`

1. Deploy dist directory to any static web host.

## Docker

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

```

# What's Inside

## Features

- 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)

## Technology

- Deno based API server using oak

- Denon to restart server on source change

- Alpine.js for DOM manipulation based on application state

- Tailwind CSS for fuzzy feeling

- Parcel for frontend dev and prod build

- TextGears API for spell checking

- GitHub gist API for storage

- Some SVG

- Docker for all in one deployment

- Support for GitHub dev container

# What more?

- Support multiple editor_passwords (e.g. one per author / role)

- Support article sources other than wordpress blog posts

- Some better UX here and there