ilalande / hackalillejs0522

Hackaton 12.05.22

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Hackaton Wild Code School -05.2022

Team : Casier Juliane, Jorand Jérémy, Mao Massima, Le Floch Romain, Di Cola Thomas

Ecology / Green IT

30h

Projet Big Bill

Jeu d'investissement dans lequel il vous faudra faire attention à vos choix. Certains vous rapporteront plus que d'autres. But du jeu : vous enrichir tout en préservant la planète.

Pour réaliser le projet nous avons utilisé le template que nous utilisons en formation. Après avoir cloné le repo, il faudra suivre les instructions suivantes :

Setup & Use

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.

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
  • 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

About

Hackaton 12.05.22


Languages

Language:JavaScript 97.8%Language:HTML 2.1%Language:Shell 0.2%