Nouveau readme

README.md

@@ -1,50 +1,28 @@
-# React + TypeScript + Vite
+# Modelec.club
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+Ce site web est le site vitrine du club Modelec, le club de robotique, d'électronique et de modelisme de l'ISEN Nantes.
+Il est réalisé en ReactJS et est compilé avec Vite.
 
-Currently, two official plugins are available:
+## Installation
-
+Pour installer le site web en local, il suffit de cloner le dépôt et d'installer les dépendances avec npm.
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+```bash
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+git clone https://github.com/modelec/modelec.club.git
-
+cd modelec.club
-## Expanding the ESLint configuration
+npm install
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-export default tseslint.config({
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
 ```
 
-- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
+## Utilisation
-- Optionally add `...tseslint.configs.stylisticTypeChecked`
+Pour lancer le serveur de développement, il suffit de lancer la commande suivante.
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
+```bash
-
+npm run dev
-```js
-// eslint.config.js
-import react from 'eslint-plugin-react'
-
-export default tseslint.config({
-  // Set the react version
-  settings: { react: { version: '18.3' } },
-  plugins: {
-    // Add the react plugin
-    react,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended rules
-    ...react.configs.recommended.rules,
-    ...react.configs['jsx-runtime'].rules,
-  },
-})
 ```
+
+Pour compiler le site web, il suffit de lancer la commande suivante.
+```bash
+npm run build
+```
+
+Pour lancer les tests unitaires, il suffit de lancer la commande suivante. Attention pour que les test unitaires via cypress fonctionnent, il faut que le serveur de développement soit lancé sur le port 8080.
+```bash
+npm run test
+```