1.2.3 • Published 9 months ago

@amsom-habitat/projimmo-builder v1.2.3

Weekly downloads
-
License
-
Repository
github
Last release
9 months ago

Projimmo Builder

Étapes abandonnées

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

NomDescriptionVersion
@fortawesomeLibrairie d'icônes6.x
bootstrapLibrairie de composants CSS5.x
dayjsLibrairie de gestion de dates1.11.x
frappe-ganttLibrairie de création de diagramme de Gantt0.6.x
sassPréprocesseur CSS (dépendance de frappe-gantt)1.77.x
vue (option API)Framework Javascript3.4.x

💡 Recommandations

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

🛠️ 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

ℹ️ Informations complémentaires

Architecture decision record (ADR)

Les décisions d'architecture sont documentées dans le dossier /docs/adr.

Ces documents permettent de comprendre les choix d'architecture pris lors du développement du projet.

Un template est disponible dans le dossier /docs/adr/template.md.

Documentation du projet

La documentation du projet est disponible dans le dossier /docs/app.

Documentation du composant

La documentation du composant est disponible dans le dossier /docs/app/Get Started.md.

1.2.0

9 months ago

1.2.3

9 months ago

1.2.2

9 months ago

1.2.1

9 months ago

1.1.2

11 months ago

1.1.1

11 months ago

1.1.0

11 months ago

1.0.9

11 months ago

1.0.8

11 months ago

1.0.7

11 months ago

1.0.5

11 months ago

1.0.4

11 months ago

1.0.3

11 months ago

1.0.2

11 months ago

1.0.1

11 months ago

1.0.0

11 months ago