web-spellchecker

web-spellchecker is a VueJs/ExpressJS full stack application for checking the spelling of any webpage.

• Enter web address -- Must be publicaly accessable (unless your running the whole service yourself)
• See list of words and if they are in the dictionary

Tech

web-spellchecker uses a number of open source projects to work properly:

• vuejs - Front End MVC framework
• buefy - Pure CSS style Library
• node.js - Evented I/O for the backend
• Express - Fast node.js network app framework
• cheerio - An implementation of core jQuery designed specifically for the server.
• axios - Promise based HTTP client for the browser and node.js.
• ws - WebSocket client and server implementation.
• hunspell - A spell checker and morphological analyser designed for languages with rich morphology and complex word compounding and character encoding

Installation Docker

From the root project directory:

docker-compose build

Installation Native

web-spellchecker requires Node.js v10+ to run.

The front end is in the './client' folder and the backend is in the './server' folder Install the dependencies and devDependencies and start the server.

$ cd web-spellchecker/client
$ npm install
$ npm run serve

$ cd web-spellchecker/server
$ npm install
$ npm run start:dev

For production environments...

$ cd web-spellchecker/client
$ npm run build

For the server I recomend pm2

Build for Heroku

run the build.ps1 script. This will build the vuejs frontend, and copy it to the server/public folder for deployment.
Then switch to the server folder and initialize that folder as new repo (first time only) and push the code changes to heroku's remote repo.

.\build.ps1
cd server
heroku login
git init
git remote add heroku https://git.heroku.com/domain-crawler.git
git add .
git commit -am "New Release"
git push heroku master

Todos

• Write MORE Tests
• Add Themes

License

MIT

Free Software, Hell Yeah!