From f5a59218eed9bdcc25958105e8f6ae4cb8b43039 Mon Sep 17 00:00:00 2001 From: Alexis Poyen <apoyen@grandlyon.com> Date: Wed, 8 Jul 2020 13:29:39 +0200 Subject: [PATCH] Describe file tree --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ef614e..5b8cb57 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,17 @@ La démo est accessible avec l'url https://sdk-go.127.0.0.1.nip.io ### Arborescence fichier +- `./data` contient les bases de données locales sqlite, users.db pour les utilisateurs et test.db pour le modèle de donnée +- `./dev-certificates` contient les fichiers nécessaires pour servir l'application en HTTPS durant le développement. +- `./internal` contient les paquets nécessaires au développement de l'application + - `./auth` contient la gestion des utilisateurs et des droits sur l'application + - `./mocks` permet de mocker l'API d'authentification pour passer les tests + - `./models` permet de définri le modèle de données et les API qui seront servies par le back-end + - `./rootmux` contient le fichier `rootmux.go` qui permet de servir les APIs, de gérer l'authentification, de servir le site web et la gestion des cookies utilisateurs. Le répertoire contient également tous les tests d'intégration sur les APIs. +- `./miscellaneous/keycloack` contient un environnement Keycloack qui peut être utilisé pour déployer un environnement OAuth2 +- `./pkg` contient les diffférents package génériques qui permettent de gérer les logs applicatifs, de créer les fonctiones de tests, la gestion des tokens... +- `./web` est le répertoire où est stockée l'application front-end et publié par le serveur back-end. + ### Utilisateurs et droits ### Tests @@ -147,4 +158,4 @@ Utilisé le système d'issue pour expliquer votre découverte ou votre popositio Vous voulez contribuez directement au code ? -Créer une issue pour expliquer votre contribution, créer une branche, développer votre fonctionnalité et faite une merge request. \ No newline at end of file +Créer une issue pour expliquer votre contribution, créer une branche à partir de cette issue, développer votre fonctionnalité sur la branche et faite une merge request. \ No newline at end of file -- GitLab