CONTRIBUTING.md

Development

The development environment for this project uses ESLint, Prettier, and stylelint for linting and formatting. This format adheres to the Airbnb style guide as close as possible for TypeScript.

Code Editor Plugins

Consider using Visual Studio Code and installing the following plugins:

• ESLint
• Prettier
• Prettier ESLint
• stylelint

Commands

These are the Node commands that can be used for working on the project. There is a pre-commit hook that is ran to ensure everything passes before committing.

Command	Description
npm run dev	Starts development server.
---	---
npm run clean	Removes client and server production build files.
npm run clean:client	Removes client production build files.
npm run clean:server	Removes server production build files.
---	---
npm run lint	Runs Prettier, ESLint and stylelint.
npm run lint:prettier	Runs Prettier.
npm run lint:eslint	Runs ESLint.
npm run lint:stylelint	Runs stylelint.
---	---
npm run build	Generates production builds for client and server.
npm run build:client	Generates production builds for client.
npm run build:server	Generates production builds for server.
---	---
npm run all	Runs clean, lint, and build.
---	---
npm run start	Starts production build.