Maj guide de développement et détail des nouveaux packages

DEVELOPMENT.md

@@ -1,11 +1,12 @@
-## Développement
+# Développement
 
-### Installation
+## Installation
 
 Prérequis :
 - [go](https://golang.org/) (testé avec 1.11)
 - [dep](https://github.com/golang/dep)
 - [mockery](https://github.com/vektra/mockery)
+- [golangci-lint](https://github.com/golangci/golangci-lint)
 - [docker-compose](https://docs.docker.com/compose/install/) (testé avec 1.19.0)
 
 Il faut d'abord installer les dépendances.
@@ -23,25 +24,47 @@ Enfin lancer l'application.
 go run main.go
 ```
 
-### Organisation
 
+## Organisation
+
+- app/ : config et bootstrap application
+- authentication/ : gestion des sessions et de l'authentification via SSO
+- cron/ : cron qui définit les tâches périodiques
 - database/ : couche d'accès à la base de données
-- httpserver/ : serveur HTTP
 - domain/ : services métier
+- emails/ : envoi d'emails par SMTP
+- errors/ : erreurs applicatives
+- events/ : gestion des événements pour mettre à jour les données automatiquement chez les clients via WebSocket
+- httpserver/ : serveur HTTP
 - models/ : entités métier
-- app/ : config et bootstrap application
-- tests/e2e/ : tests end-to-end
+- redis/ : client [Redis](https://redis.io)
+- storage/ : gestion des documents (pièces-jointes et rapports) via [Minio](https://min.io)
+- templates/ : gestion et rendu des templates (documents ODT et emails)
+- tests/benchmark/ : tests de benchmark
+- tests/e2e/ : tests end-to-end (HTTP)
+- tests/integration/ : tests d'intégration (services)
+- util/ : fonctions utilitaires
 - vendor/ : contient les dépendances
 - main.go : point d'entrée
+- gopkg.toml : fichier descripteur des dépendances
+
 
+## Lint
 
-### Mise à jour des mocks
+[golangci-lint](https://github.com/golangci/golangci-lint) permet de linter le code.
+
+```sh
+golangci-lint run
+```
+
+## Mise à jour des mocks
 
 ```
 go generate ./...
 ```
 
-### Tests
+
+## Tests
 
 Lancement d'un test :
 ```
@@ -57,7 +80,7 @@ go test -p 1 -v ./...
 - `FILHARMONIC_DATABASE_LOGSQL=1` permet d'afficher les requêtes SQL.
 
 
-### Benchmarks
+## Benchmarks
 
 On utilise [k6](https://k6.io/), qui permet d'écrire des scénarios en javascript.
 
@@ -72,7 +95,7 @@ docker run -it --rm -v $PWD/tests/benchmark/:/benchmark --network host loadimpac
 ```
 
 
-### Modifications du modèle
+## Modifications du modèle
 
 Pour vérifier que le schéma des migrations correpond bien à celui des structures, lancer le script suivant :
 ```

README.md

@@ -7,6 +7,10 @@
 
 Application en cours de développement et accessible sur [filharmonic.beta.gouv.fr](https://filharmonic.beta.gouv.fr).
 
+## Développement
+
+Voir le [guide de développement](./DEVELOPMENT.md).
+
 ## Crédits
 
 ### Production