@amsom-habitat/projimmo-builder NPM

Projimmo Builder

Projimmo Builder est le composant permettant de concevoir, suivre et entretenir les opérations sur le projet Projimmo.

Ce projet est réalisé avec Vue.js v3.x en option API.

📋 Dépendances

Nom	Description	Version
`@fortawesome`	Librairie d'icônes	`6.x`
`bootstrap`	Librairie de composants CSS	`5.x`
`dayjs`	Librairie de gestion de dates	`1.11.x`
`frappe-gantt`	Librairie de création de diagramme de Gantt	`0.6.x`
`sass`	Préprocesseur CSS (dépendance de `frappe-gantt`)	`1.77.x`
`vue` (`option API`)	Framework Javascript	`3.4.x`

💡 Recommandations

Pour le assurer le bon développement de l'application, nous vous recommandons d'utiliser les outils suivants :

Docker ou Orbstack (disponible sur MacOS uniquement)
Visual Studio Code ou WebStorm
Node.js (version 20.16.x ou supérieure)
Gitmoji CLI
NVM
PNPM
Ni
Sur Windows, utiliser WSL2

🛠️ Installation du projet en local

Cloner le projet

git clone git@github.com:AMSOM-Dev/projimmo-builder.git

Se déplacer dans le dossier du projet

cd projimmo-builder

🐳 Installation avec Docker

Construire l'image Docker et installer les dépendances

make first-install

💻 Installation en local (sans Docker)

Utiliser la version de Node recommandée

nvm install

Installer les dépendances Node

ni # Avec l'outil Ni
pnpm install # Avec PNPM   /!\ Ne pas utiliser NPM, Yarn ou autre gestionnaire de paquets

🧑‍💻 Lancer le projet en local

🐳 Lancer le serveur de développement avec Docker

make dev

💻 Lancer le serveur de développement en local (sans Docker)

nr dev # Avec l'outil Ni
pnpm run dev # Avec PNPM

Accéder à l'application

Ouvrir un navigateur web et accéder à l'adresse suivante : http://localhost:80

Ou si vous utilisez Orbstack, accéder à l'adresse suivante : https://projimmo-builder.local

🚀 Déploiement en production

⚠️ Attention : Avant de déployer le projet en production, assurez-vous d'avoir définis la variable d'environnement VITE_NODE_ENV à "prod".

🐳 Déployer le projet avec Docker

Connectez vous à votre compte NPM (hors conteneur) et saisissez la commande suivante :

pnpm version <patch/minor/major>
make publish

💻 Déployer le projet sans Docker

Compiler le projet

nr build # Avec l'outil Ni
pnpm run build # Avec PNPM

Publier le composant sur NPM

Connectez vous à votre compte NPM et saisissez la commande suivante :

pnpm version <patch/minor/major>
pnpm publish --access public

🔌 Règles de commits

Merci de respecter les règles de commits suivantes :

Les messages de commits doivent être en anglais
Les messages de commits doivent être préfixés par un emoji (voir Gitmoji)
Les messages de commits doivent décrits de manière claire et précise les modifications apportées
Les commits doivent être atomiques