Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.86 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.86 KB
Raw

Cocktail Paradise

Projet 2 JS/React Septembre 2022 composé de :

  • Gregory Ledez
  • Alexandre Sarrazin
  • Olga Yasnopolskaya
  • Mehdy Guettache
  • Anthony Labadie

Concept

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.

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
  • dev : Starts both servers (frontend + backend) in one terminal
  • dev-front : Starts the React frontend server
  • dev-back : Starts the Express backend server
  • 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 !)

FAQ

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