Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 2.03 KB

README.md

File metadata and controls

91 lines (64 loc) · 2.03 KB

Boilerplate Front-end tooling 🤓

Un projet front-end créé avec Vite dans le cadre du cours de Front-end Tooling.

Aperçu 🕶️

Ce projet est un boilerplate (modèle de démarrage) pour les projets front-end utilisant Vite, une technologie de développement rapide pour les applications web. Il est conçu pour vous permettre de démarrer rapidement avec la configuration minimale et les outils nécessaires pour développer des applications web modernes.

Installation 🗂️

  1. Clonez ce dépôt vers votre machine locale :
git clone https://github.com/Lucas-Huerta/fronttooling.git

cd nom-du-projet

npm install
# ou
yarn

npm install
# ou
yarn

npm run build
# ou
yarn build

Technologies incluses ⚙️

Ce modèle de démarrage inclut les technologies suivantes :

  • VueJs 3
  • Storybook
  • Un système de test avec Jest
  • Hooks personnalisés dans src/hooks
  • Un Linter
  • Husky pour les gits hooks
  • Des styles pré-configurés dans le dossier src/styles
  • Un .env et .env-example
  • Les imports absolus en utilisant @ comme préfix

Commandes disponibles ⌨️

Dans le répertoire du projet, vous pouvez exécuter les commandes suivantes :

npm run dev
# ou
yarn dev

Lance l'application en mode développement.

npm run build
# ou
yarn build

Construit l'application pour la production dans le dossier dist.

npm run storybook
# ou
yarn storybook

Lance le serveur de développement Storybook.

npm run lint
# ou
yarn lint

Exécute le linter pour vérifier les problèmes de style de code.

npm run test
# ou
yarn test

Exécute les tests unitaires.

Variables d'environnement ⍵

Ce projet utilise des variables d'environnement pour configurer certains aspects de l'application. Vous pouvez créer un fichier .env à la racine du projet pour définir ces variables. Un fichier d'exemple est fourni dans env-example.