Import UD from Google Doc.

Makefile

@@ -2,12 +2,17 @@ PANDOC = pandoc
 TEMPLATE_PATH = ./template.tex
 PDF_ENGINE = tectonic
 
-NAME = output
+NAME = 2023_UD1_Pizzi
 EXT = pdf
 SOURCES_DIR = ./src/
 RESOURCE_PATH = .
 
-SOURCES = 00_info.md
+SOURCES = 00_info.md \
+					01_intro.md \
+					02_users.md \
+					03_architecture.md \
+					04_shopkeeper_software.md \
+					05_phone-app.md
 
 PANDOC_METADATA_OPTIONS = --metadata date="`date -u '+%d / %m / %Y'`"
 PANDOC_OPTIONS = --resource-path $(RESOURCE_PATH) --template $(TEMPLATE_PATH) $(PANDOC_METADATA_OPTIONS) --highlight-style pygments

src/00_info.md

@@ -2,19 +2,56 @@
 project: Pizzi
 author:
   - Groupe Pizzi - PROMO 2023
-title: 'Titre'
-subtitle: 'Sous-titre'
+title: 'Documentation utilisateur'
 lang: fr
 ---
 
 # Résumé
 
+Ce document regroupe la documentation utilisateur du projet.
+
+Pizzi est un écosystème complet de paiement pour les clients et les
+commerçants. 
+
+Les clients peuvent payer via leur moyen de paiement préféré, tout en recevant
+leur reçu numérique, consultable immédiatement sur l'application mobile Pizzi. 
+
+Les commerçants possèdent un terminal de paiement connecté, associé à un
+logiciel de caisse modulable optimisé pour l'écosystème. 
+
+Cette documentation possède deux grandes parties, la partie Application Mobile
+destinée aux utilisateurs lambda de l'application et la partie Logiciel
+Commerçant destinée aux professionnels qui se serviront du logiciel Pizzi.
+
+Dans ce document, dans un premier lieu, nous présenterons le projet Pizzi et le
+cadre Epitech, pourquoi ce projet a de l'importance et quel est l'impact qu'il
+peut avoir dans le monde qui nous entoure. Nous détaillerons également la cible
+de notre logiciel.
+
+Dans un second temps, vous pourrez retrouver le guide de démarrage et de
+présentation du Logiciel commerçant. Toutes les étapes seront présentées de la
+création de compte jusqu'à la création de sa première transaction.
+
+Dans la troisième partie du document, nous nous concentrons sur l'application
+mobile avec un guide de démarrage et un tour des différentes fonctionnalités de
+l'application.
+
+Ce document permet d'expliquer et d'accompagner chaque utilisateur souhaitant
+démarrer avec l'écosystème Pizzi. 
+
+Ce projet est en constante amélioration, au fur et à mesure de l'avancement du
+projet. Nous ajouterons dans ce document les nouvelles fonctionnalités et les
+bonnes pratiques.
+
+Pour toute question ou renseignement, n'hésitez pas à nous contacter à
+l'adresse mail suivante: `pizzi_2023@labeip.epitech.eu`
+
 \clearpage
 
 ## Métadonnées du document
 
-- **Titre**: TODO Add document title
-- **Objet**: TODO Add document subtitle
+- **Titre**: Documentation utilisateur
+- **Objet**: Guide de démarrage de l'écosystème Pizzi
 - **Auteur**: Groupe Pizzi
 - **Email**: 
   - remi.poulenard@epitech.eu
@@ -27,10 +64,13 @@ lang: fr
 
 ## Tableau des révisions
 
-| **Date**         | **Version**   | **Auteur**            | **Section(s)**          | **Commentaires**                    |
-| ---------------- | ------------- | --------------------  | ----------------        | ----------------------------        |
-| 07/08/2022       | 0.1           | Mathieu Pointecouteau | Toutes                  | Création du template                |
-| 02/12/2022       | 0.2           | Mathieu Pointecouteau | En-tête et pied de page | Ajout du nom de la section en cours |
+| **Date**         | **Version**   | **Auteur**            | **Section(s)**      | **Commentaires**                                                                     |
+| ---------------- | ------------- | --------------------  | ----------------    | ----------------------------                                                         |
+| 07/08/2022       | 0.1           | Mathieu Pointecouteau | Toutes              | Création du template                                                                 |
+| 11/08/2022       | 1.0           | Rémi Poulenard        | Toutes              | Première Version                                                                     |
+| 13/08/2022       | 1.1           | Rémi Poulenard        | Logiciel commerçant | Ajout des images et conclusion                                                       |
+| 13/08/2022       | 1.2           | Valentin Mille        | Application Mobile  | Guide utilisateur                                                                    |
+| 03/12/2022       | 1.3           | Mathieu Pointecouteau | Toutes              | Importation dans le template Pizzi de la documentation utilisateur depuis Google Doc |
 
 \clearpage
 

src/01_intro.md

@@ -0,0 +1,56 @@
+# Rappel du projet
+
+## Qu'est-ce que Pizzi et quel est le rapport avec Epitech?
+
+Epitech est une école d'informatique en 5 ans spécialisée dans la formation des
+développeurs de demain avec un accent tout particulier sur l'innovation. 
+
+Lors du cursus Programme Grande École, nous débutons dès la 3ème année un EIP
+(ou Epitech Innovative Project), c'est-à-dire, un projet innovant répondant à
+un besoin de la société. 
+
+Le but de l'EIP est de nous faire développer de façon autodidacte une
+entreprise avec tout ce que cela implique : développer un business model, avoir
+une stratégie sur le long terme, connaître les aspects légaux de son secteur
+d'activité. 
+
+Ayant acquis une solide base technique lors des précédentes années, nous la
+mettons ici à profit afin de développer un projet unique. 
+
+Notre projet s'appelle Pizzi.  
+Pizzi est un écosystème complet de paiement pour les clients et les
+commerçants.  
+Les clients peuvent payer sans contact via une application sur smartphone, tout
+en recevant leur reçu numérique, consultable immédiatement sur l'application
+mobile Pizzi.  
+Les commerçants possèdent un terminal de paiement connecté, associé à un
+logiciel de caisse modulable optimisé pour l'écosystème. 
+
+## Pourquoi le projet Pizzi est important pour la planète
+
+
+Chaque année en France, des millions d'arbres sont utilisés afin de produire 15
+milliards de tickets de caisse. C'est à partir de ce constat que nous avons
+cherché comment nous pouvions utiliser notre savoir-faire technique pour
+réduire ce problème. 
+
+Notre but est simple, supprimer les tickets de caisse physiques. 
+
+Pizzi est un écosystème complet de paiement pour les clients et les
+commerçants. 
+
+Les clients peuvent payer sans contact via une application sur smartphone, tout
+en recevant leur reçu numérique, consultable immédiatement. 
+
+Les commerçants possèdent, quant à eux, un terminal de paiement connecté,
+associé à un logiciel de caisse modulable optimisé pour l'écosystème. Ils
+peuvent également récupérer un reçu digital consultable instantanément et avec
+une origine traçable. 
+
+Grâce à l'outil informatique, nous pouvons aujourd'hui nous passer des tickets
+de caisse. 
+
+De plus, en 2023, la loi anti-gaspillage impose l'interdiction d'impression des
+tickets de caisse (sauf demande du client) pour un montant inférieur à 20
+euros. Nous pensons que notre projet peut être une alternative pour tous les
+montants.

src/02_users.md

@@ -0,0 +1,19 @@
+# Utilisateurs
+
+Notre solution se base sur deux grands types d'utilisateurs: le commerçant et
+le client. 
+
+Le commerçant est un utilisateur interne de la solution, en effet, c'est à lui
+que nous vendons directement notre solution. Il travaille avec nos produits (un
+terminal de paiement et un logiciel de caisse) afin de réaliser ses
+transactions journalières. 
+
+Le client est un utilisateur externe de notre solution. Il pourra interagir
+avec notre écosystème grâce à une application mobile contenant ses moyens de
+paiements préférés ainsi qu'un système de gestion des reçus de caisse
+numériques. 
+
+De notre côté, nous possédons deux utilisateurs internes: l'administrateur
+pouvant effectuer des actions de maintenance et de support utilisateur ainsi
+que la partie back-end regroupant la gestion des bases de données, des API
+ainsi que le système d'authentification. 

src/03_architecture.md

@@ -0,0 +1,7 @@
+# Architecture du projet
+
+Notre solution se découpe en trois grandes parties : le logiciel commerçant,
+l'application mobile et le terminal de paiement connecté.
+
+Ces trois parties sont supportées par une API et un back-end permettant de
+traiter et de récupérer la donnée dynamiquement. 

src/04_shopkeeper_software.md

@@ -0,0 +1,154 @@
+# Logiciel Commerçant (Bêta)
+
+## Comment accéder au logiciel commerçant Pizzi
+
+Dans le cadre de la bêta vous pouvez accéder directement au logiciel commerçant
+via le lien suivant: \url{https://pizzi-webapp.netlify.app}.
+
+Le logiciel est une application web car il peut être embarqué sur des
+ordinateurs ou des tablettes sans importance concernant la version.
+
+Veuillez prendre contact avec notre équipe technique afin de relier le terminal
+de paiement au support que vous utilisez.
+
+## Inscription
+
+Vous pouvez directement créer un compte sur le logiciel Pizzi. Pour cela, vous
+pouvez vous inscrire en vous rendant sur la page sign up (voir
+\autoref{fig:shopkeeper-software-sign-up}). Cette page est accessible
+directement depuis la page de Connexion en cliquant sur `Créez votre
+compte` (voir \autoref{fig:shopkeeper-software-connection}).
+
+En suivant les étapes, vous devrez mentionner votre email, choisir un mot de
+passe sécurisé puis renseigner des informations sur votre commerce. Une fois
+toutes les étapes réalisées vous pourrez directement vous connecter en allant
+sur la page Connexion.
+
+\begin{figure}[H]
+  \centering
+  \includegraphics[width=0.8\textwidth]{resources/shopkeeper-software/sign-up.png}
+  \caption{Logiciel commerçant - Création de compte}
+  \label{fig:shopkeeper-software-sign-up}
+\end{figure}
+
+## Connexion
+
+Lorsque vous êtes déjà munis d'identifiants, vous pouvez simplement vous
+connecter en renseignant votre e-mail, mot de passe puis cliquer sur
+`Connexion`, si vos identifiants sont corrects vous allez être automatiquement
+redirigé vers la page Tableau de bord (voir
+\autoref{fig:shopkeeper-software-dashboard}).
+
+Veuillez nous contacter le cas échéant ou pour quelconque information
+concernant vos identifiants. Nous serons capables de vous fournir des
+identifiants de substitution ou de régler tout problème pouvant intervenir.
+
+\begin{figure}[H]
+  \centering
+  \includegraphics[width=0.8\textwidth]{resources/shopkeeper-software/connection.png}
+  \caption{Logiciel commerçant - Connexion}
+  \label{fig:shopkeeper-software-connection}
+\end{figure}
+
+## Le tableau de bord
+
+Le tableau de bord est la page d'accueil
+(\autoref{fig:shopkeeper-software-dashboard}). À partir de cette page, vous
+retrouverez des widgets configurables selon vos soins qui peuvent afficher vos
+dernières ventes, vos profits ou bien les items que vous vendez avec les prix.
+Les graphiques sont dynamiques et interagissent directement avec votre base de
+données.
+
+\begin{figure}[H]
+  \centering
+  \includegraphics[width=0.8\textwidth]{resources/shopkeeper-software/dashboard.png}
+  \caption{Logiciel commerçant - Tableau de bord}
+  \label{fig:shopkeeper-software-dashboard}
+\end{figure}
+
+Sur la gauche du Dashboard, vous retrouvez un panel permettant d'accéder à
+toutes les fonctionnalités de la plateforme.
+
+## Gestion des items de votre commerce
+
+Afin de personnaliser votre logiciel commerçant et d'avoir la main sur votre
+solution vous pouvez vous même enregistrer vos produits ou items en ajoutant un
+prix et un intitulé. Afin d'ajouter un produit, veuillez cliquer sur le bouton
+bleu `Ajouter`. Grâce aux boutons d'actions de la liste vous pourrez également
+supprimer ou éditer un item pour toute modification que vous souhaitez
+effectuer.
+
+\begin{figure}[H]
+  \centering
+  \includegraphics[width=0.8\textwidth]{resources/shopkeeper-software/product-register.png}
+  \caption{Logiciel commerçant - Registre des produits}
+  \label{fig:shopkeeper-software-product-register}
+\end{figure}
+
+## Créer une nouvelle transaction
+
+Les items que vous pouvez retrouver sur la page `Product Register`
+(\autoref{fig:shopkeeper-software-product-register}) sont automatiquement
+disponibles dans la partie génération de reçu
+(\autoref{fig:shopkeeper-software-generate-receipt}). Ils sont mis à jour
+avec la base de données afin d'avoir vos dernières modifications. Pour réaliser
+une transaction, veuillez sélectionner les items pour les ajouter au reçu puis
+cliquez sur `Générer reçu`. La transaction est lancée. Une fois le paiement
+accepté vous retrouverez le reçu au format PDF et vous pouvez afficher un QR
+CODE afin que le client disposant de l'application mobile Pizzi puisse
+récupérer son reçu dynamique à partir de la transaction. Il pourra ensuite
+consulter ou retourner un produit de façon dynamique.
+
+\begin{figure}[H]
+  \centering
+  \includegraphics[width=0.8\textwidth]{resources/shopkeeper-software/generate-receipt.png}
+  \caption{Logiciel commerçant - Génération de ticket}
+  \label{fig:shopkeeper-software-generate-receipt}
+\end{figure}
+
+## Effectuer un retour produit
+
+Le logiciel Pizzi vous propose des retours de produits interactifs via
+l'application mobile client. Le client sélectionne l'item qu'il veut retourner
+sur son reçu dynamique dans l'application puis vous présente un QR CODE ou un
+identifiant que vous devez rentrer dans la partie `returned product`. Vous
+êtes ensuite libre de choisir la méthode que vous préférez afin de rembourser
+le client.
+
+## Édition de son profil
+
+Nous vous proposons une page afin d'éditer directement vos informations ainsi
+que les informations de votre commerce
+(\autoref{fig:shopkeeper-software-edit-profile}). Vous pourrez y ajouter
+votre adresse, vos horaires, numéros de téléphone ainsi que les liens vers vos
+réseaux sociaux. À terme, toute la gestion de votre marque se déroulera sur
+cette page.
+
+\begin{figure}[H]
+  \centering
+  \includegraphics[width=0.8\textwidth]{resources/shopkeeper-software/edit-profile.png}
+  \caption{Logiciel commerçant - Édition de son profil}
+  \label{fig:shopkeeper-software-edit-profile}
+\end{figure}
+
+## Consulter ses dernières transactions
+
+Dans le panneau de gauche sur `Dernières Transactions` vous pouvez retrouver
+toutes vos transactions réalisées via le logiciel Pizzi
+(\autoref{fig:shopkeeper-software-view-transaction}). Vous y retrouverez la
+date, le montant ainsi que le type d'item vendu. Dans une prochaine mise à
+jour, vous y trouverez directement le reçu digital. 
+
+\begin{figure}[H]
+  \centering
+  \includegraphics[width=0.8\textwidth]{resources/shopkeeper-software/view-transactions.png}
+  \caption{Logiciel commerçant - Dernières transactions}
+  \label{fig:shopkeeper-software-view-transaction}
+\end{figure}
+
+## Désintallation / Suppresion de compte
+
+Afin de supprimer votre compte, veuillez prendre contact avec le support Pizzi
+(`pizzi_2023@labeip.epitech.eu`). Nous pourrons ensuite vous transmettre vos
+données si vous souhaitez exporter vos chiffres vers d'autres plateformes à des
+fins de conservation ou de statistiques.