Use the following commands from the root of the repo:
npm i # install all packages
npm start # start the front and backend
npm run lint # show but not fix
npm run lint:fix # show and attempt to fix automatically
npm run format # fix formatting
npm run format:check # check formatting but not fixYou will need to have Node.js installed on your machine. You can download it here.
You can download MySQL here
Requires a MySQL database to be running.
In order to configure the backend, create a .env file in the backend directory based on the .env.example file.
Open the extensions page and type @recommended to see a list of the recommended extensions
Type command shift P and type format to select prettier
The repo is setup with linting, specifically with ESLint and Prettier To enable linting in your editor, you may need to install the ESLint and Prettier extensions. There are also pre-commit hooks setup to run linting before a commit is made. You will need to fix these issues before making a commit. You can also manually run linting with the following command:
npm run lint # show but not fix
npm run lint:fix # show and attempt to fix automatically
npm run format # fix formatting
npm run format:check # check formattingThis repo is setup with git hooks using Husky and Lint-Staged.
Any time a commit is made, all files will be linted and formatted. If there are any issues, the commit will be rejected.