This template is meant to serve as a foundation for every P2/P3 following the React-Express-MySQL stack, as learned in Wild Code School. It's pre-configured with a set of tools which'll help students produce industry-quality and easier-to-maintain code, while staying as simple as possible to use.
- In VSCode, install plugins Prettier - Code formatter and ESLint and configure them
- Clone this repo, enter it
- Run command
npm run setup - NB: To launch the backend server, you'll need an environment file with database credentials. You'll find a template one in
backend/.env.sample
setup: Initialization of frontend and backend, as well as all toolingsmigrate: Run the database migration scriptdev: Starts both servers (frontend + backend) in one terminaldev-front: Starts the React frontend serverdev-back: Starts the Express backend serverlint: Runs validation tools, and refuses unclean code (will be executed on every commit)fix: Fixes linter errors (run it iflintgrowls on your code !)
- Concurrently : Allows for several commands to run concurrently in the same CLI
- Husky : Allows to execute specific commands that trigger on git events
- Vite : Alternative to Create-React-App, packaging less tools for a more fluid experience
- ESLint : "Quality of code" tool, ensures chosen rules will be enforced
- Prettier : "Quality of code" tool as well, focuses on the styleguide
- _ Airbnb Standard_ : One of the most known "standards", even though it's not officially linked to ES/JS
- Nodemon : Allows to restart the server everytime a .js file is udated