README

This is a base template for use with SWAT, if you are unsure what that means, you probably don't need this repository ;)

A description of the project and it's deliverables here, along with the existing site URLS.

☁️ Hosting

Details about where the site is hosted and any special considerations.

Environment	Branch	Main purpose	Description
QA	feature/X	ImageX QA	Tugboat env, QA on PR's (optional).
DEV	master	ImageX DEV	Contains code approved by Lead Dev.
STAGE	stage	Client UAT	Contains code approved on DEV by QA.
PRODUCTION	prod	Content entry	Code and Database/Content that will be launched

Brief explanation of development special considerations.

List out the commands needed for a developer to start this project. (i.e. clone xx, fin init, etc)

Run this command to sync the sanitized remote database, files, and configuration:

fin sync

Describe anything of note that a developer might find useful.

drush my:command --isgreat

See FRONTEND.md for more information.

fin yarn lint # Run code linters.
fin yarn lint:fix # Run code linters and automatically fix issues.

IMPORTANT: Validation errors prevent remote pushes and cause CI/CD pipelines failures.

fin yarn spellcheck # Run spellcheck.
fin yarn spellcheck:dictionary # Generate new project dictionary words.

IMPORTANT: Generate project dictionary words only after running the spellchecker.