Description

Start of the Project on 28/11/2022
End of the Project on 01/02/2023

Welcome to our 3rd Wild Code School project.

In partnership with @makesense we have developed a solution for internal decision making and ideation.

The main goal of this solution is to allow each employee to propose ideas and to make them known.

The follow-up of these ideas is done through comments written by other employees, then an edition of three votes on which the people impacted can make their choice to promote the final decision of the said idea.

Build with

• React
• Sass
• mySql
• Node.js

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

 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

  npm run setup

• migrate : Run the database migration script

  npm run migrate

• dev : Starts both servers (frontend + backend) in one terminal

  npm run dev

• dev-front : Starts the React frontend server

  npm run dev-front

• dev-back : Starts the Express backend server

  npm run dev-back

• fix : Fixes linter errors

  npm run fix

Author

👤Florian BOUCHEZ 🇫🇷 Contact me 🇬🇧:fbouchez.pro@gmail.com

• Github: @Bouchez Florian
• LinkedIn: @Bouchez Florian

👤Alexis FOULONT 🇫🇷 Contact me 🇬🇧:alexisfoulont@gmail.com

• Github: @Foulont Alexis
• LinkedIn: @Foulont Alexis

👤Kevin GUEGUEN 🇫🇷 Contact me 🇬🇧:gueguenk@gmail.com

• Github: @Kevin Gueguen
• LinkedIn: @Kevin Gueguen

👤Valentin WAQUET 🇫🇷 Contact me 🇬🇧:waquetv@gmail.com

• Github: @Valentin Waquet
• LinkedIn: @Valentin Waquet

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

===============================================================================================================================================================================================================================================================================================================================================================================================================================================

Introduction

Bienvenue sur notre 3ème projet de formation de developpement Web à la Wild Code School.

En partenariat avec makesense nous avons développé une solution de prise de décision et d'idéation interne à l'entreprise.

Le but de celle-ci est de permettre à chaque collaborateur de proposer des idées et d'en faire connaitre les tenants et aboutissants.

Le suivi de ces dernières passe par des commentaires écrits par les autres collaborateurs , puis une édition de trois votes sur lesquels les personnes impactées peuvent se positionner et influencer la décision finale.

Construit avec

• React
• Sass
• mySql
• Node.js

Installation & Utilisation

Pour commencer un projet

• Sur VSCode, installer les plugins Prettier - Code formatter et ESLint et les configurer
• Cloner ce dépôt, se rendre à l'intérieur
• Lancer la commande npm run setup

 npm run setup

• NB: Pour exécuter le backend, un fichier d'environnement avec les données de connexion d'une BdD valide est nécesaire. Un modèle se trouve dans backend/.env.sample

Liste des commandes et signification

• setup : Initialisation du frontend et du backend ainsi que des outils

 npm run setup

• dev : Démarrage des deux serveurs (frontend + backend) dans un même terminal

 npm run dev

• dev-front : Démarrage d'un serveur React pour le frontend

  npm run dev-front

• dev-back : Démarrage d'un serveur Express pour le backend

  npm run dev-back

• fix : Fixe les erreurs de formatage

  npm run fix

Auteurs

👤Florian BOUCHEZ 🇫🇷 Contactez moi 🇬🇧:fbouchez.pro@gmail.com

• Github: @Bouchez Florian
• LinkedIn: @Bouchez Florian

👤Alexis FOULONT 🇫🇷 Contactez moi 🇬🇧:alexisfoulont@gmail.com

• Github: @Foulont Alexis
• LinkedIn: @Foulont Alexis

👤Kevin GUEGUEN 🇫🇷 Contactez moi 🇬🇧:gueguenk@gmail.com

• Github: @Kevin Gueguen
• LinkedIn: @Kevin Gueguen

👤Valentin WAQUET 🇫🇷 Contactez moi 🇬🇧:waquetv@gmail.com

• Github: @Valentin Waquet
• LinkedIn: @Valentin Waquet

Listing des outils utilisés

• Concurrently : Permet d'exécuter plusieurs commandes dans un même terminal
• Husky : Permet d'exécuter des actions en déclenchement de commandes git
• Vite : Alternative à Create-React-App, embarquant moins de packages pour une expérience plus fluide
• ESLint : Outil de "qualité de code", permet de s'assurer que des règles pré-configurées sont bien respectées
• Prettier : Outil de "qualité de code" également, se concentre plus particulièrement sur le style du code
• Standard Airbnb : L'un des "standards" les plus connus, même s'il n'est pas officiellement lié à ES/JS
• Nodemon : Outil permettant de relancer un serveur à chaque fois qu'un des fichiers est modifié