Figma

Design: link to the design

Setup & Use

Project Initialization

• 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

Available Commands

• setup : Initialization of frontend and backend, as well as all toolings
• migrate : Run the database migration script
• migrate:clear : Clear database (delete definitively!!!)
• dev : Starts both servers (frontend + backend) in one terminal
• dev:front : Starts the React frontend server
• dev:back : Starts the Express backend server
• test:unit : Test both servers with Jest
• test:front : Test frontend app
• test:back : Test backend app
• lint : Runs validation tools, and refuses unclean code (will be executed on every commit)
• fix : Fixes linter errors (run it if lint growls on your code !)

Tools

• 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

TO DO

• implement Jest extension on VS for monorepo