Documentation

Maintenant que nous avons un projet conséquent, on souhaite documenter notre travail pour faciliter la maintenance et la collaboration.

Documentation

Vérifiez et complétez le fichier boutique-documentation.md créé lors de l’analyse conceptuelle pour vous assurez qu’il contient bien les éléments suivants :

1. Une description du projet
2. L’énoncé du projet
3. La décomposition du projet
4. Les propositions élémentaires
5. Les propositions retenues
6. Le modèle conceptuel de données

Vous pouvez aussi lister les différents fichiers de votre projet et leur rôle.

Fichier README

Créez un fichier README.md à la racine de votre projet. Ce fichier est un fichier de documentation standard dans le monde du développement logiciel. Il est souvent utilisé pour décrire le projet, expliquer comment l’installer et le lancer, et donner des informations sur la manière de contribuer.

Voici un exemple de contenu pour votre fichier README.md :

README.md

# Boutique en ligne

Ce projet présente la conception de la base de données d'une boutique en ligne.

## Fonctionnalités

- Génération du schéma aux formats SQL et SVG à partir d'un fichier DBML
- Génération de données de test avec Faker PHP
- Création de la base de données dans un SGBD
- Insertion des données dans la base de données

## Prérequis

Les logiciels suivants sont nécessaires pour exécuter ce projet :

- [Git](https://git-scm.com/)
- [PHP 8+](https://www.php.net/downloads.php)
- [Composer](https://getcomposer.org/)
- [NodeJS](https://nodejs.org/)
- [npm](https://www.npmjs.com/) (En général installé avec NodeJS)
- Un serveur de base de données [MySQL](https://www.mysql.com/), [MariaDB](https://mariadb.org/) ou [PostgreSQL](https://www.postgresql.org/)

## Installation

1. Cloner le dépôt
2. Installer les dépendances NodeJS avec `npm install`
3. Installer les dépendances PHP avec `composer install`
4. Dupliquer le fichier `.env.example` en `.env` à la racine du projet et ajoutez-y les informations de connexion à votre base de données
5. Exécuter le script `boutique-generate.php` pour générer le schéma de la base de données, les données de test et les insérer dans la base de données

```
git clone https://github.com/erralb-uga/boutique.git
cd boutique
npm install
composer install
cp .env.example .env
```

Modifier le fichier `.env` pour ajouter les informations de connexion à votre SGBD

```
php boutique-generate.php --dbml --generate --data
```

## Diagramme ERD

![Diagramme ERD](boutique-erd.svg)

Prenez un moment pour effectuer un commit et publier vos modifications sur GitHub.

Vous pouvez passer en revue et comparer votre projet avec le mien : https://github.com/erralb-uga/boutique