Bibliothéque Numérique

Contexte

La solution Bibliothèque Numérique proposée s’appuie sur et complète les outils de gestion de téléprocédures SVE (ministère de l’intérieur) et Démarche-Numérique (DINUM) afin de permettre, suite à la phase d’instruction de démarches de déclaration, l’interaction multi-acteurs autour de ces données, afin d’en tirer des analyses et actions légales éventuelles.

Dans cette solution est incorporé un système de référence des fondations et des associations, RAF.

Installation

Prérequis

1. Outils nécessaires (tous modes)

• Docker - moteur d'exécution de conteneur

2. Outils supplémentaires (mode développement uniquement)

• Nodejs - environnement d'exécution javascript/typescript
• Pnpm - gestionnaire de paquets et workspaces pour javascript
• turbo - Outil de monorepo

3. Services externes requis

• Un jeton d'authentification pour l'API Démarche-Numérique

Lancer les applications

1. Architecture

L’application fonctionne entièrement via conteneurs Docker.

📄 Voir Architecture de l’application

• Les services utilisés

  • Postgres - Le systeme de base de données relationnel
  • Redis - Pour le systeme de Queue
  • Minio - Pour le systeme de stockage de fichiers S3
  • mailhog - un faux server SMTP pour récuper les e-mails

• Les outils d'administration

  • pgAdmin - Outil d'administration de base données
  • Adminer - Outil d'administration de base données léger
  • bull-board - Outil de suivi de jobs et queues

2. Lancer en mode simple (Docker)

git clone https://github.com/dnum-mi/bibliotheque-numerique.git

cd bibliotheque_numerique

bin/start.sh
# Suivre les instructions pour configurer le jeton d'API de Démarche Numérique dans la variable d'environnement DS_API_TOKEN

Naviguez ensuite vers http://localhost:8088 pour accéder à l'application.

Compte administrateur par défaut :

• Email: admin@localhost.com
• Mot de passe: Password2OpenBN!

3. Lancer en mode développement

La page DEVELOPMENT explique comment lancer la Bibliothèque Numérique en mode développement.

Documentation du Code

Certains chapitres de la Bibliothèque Numérique peuvent être difficiles à comprendre. C’est pourquoi des documents spécifiques ont été rédigés sur ces sujets. L’ensemble des documents techniques est répertorié dans docs/ :

Dossier Pagination des Dossiers :

Ce dossier contient un fichier Markdown qui explique la pagination des dossiers, accompagné d'un fichier Excel avec de fausses données pour illustrer les exemples de code présents.

Dossier Structure du Code :

Contient un fichier Markdown expliquant la structure du backend. Ce document devrait être le premier lu par un nouveau développeur cherchant à se familiariser avec le backend.

Dossier Synchronisation :

Contient un fichier Markdown expliquant la synchronisation des données entre Bnum et DS. Ce dossier inclut également un sous-dossier Code qui explique le système de codes de synchronisation.