README.md

Typo CI

Checks for spelling errors within commits by listening to webhooks from GitHub.

Setup & Local Dev

docker-compose build
docker-compose run --rm web bin/setup

Symlink puma-dev

This allows you run run the dashboard part of the app locally.

ln -s ~/.puma-dev/typoci .
echo "3000" > ~/.puma-dev/typoci

Running locally

docker-compose up

Running one off commands

Enter shell within the docker container with:

docker-compose run --rm --no-deps web bash

Sources

• Dictionaries source
• CSpell Dictionaries