Skip to content

Commit

Permalink
docs: mise à jour du README (#2024)
Browse files Browse the repository at this point in the history
Mise à jour du schéma d'architecture
Ajout du schéma de base de données
Suppression de la partie Nix (obsolète)
  • Loading branch information
HadrienMP authored Oct 18, 2023
1 parent 4cb1e45 commit b75f27f
Show file tree
Hide file tree
Showing 8 changed files with 4,805 additions and 143 deletions.
22 changes: 0 additions & 22 deletions .envrc

This file was deleted.

26 changes: 2 additions & 24 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Vous devez au préalable avoir correctement installé les logiciels suivants :
- [make](https://www.gnu.org/software/make/)
- Il vient souvent pré-installé et est disponible sur les gestionnaires de paquets


### ASDF (alternative facultative)
Pour faciliter l'installation des versions requises de `node`, `hasura-cli`, `poetry` et `python`, un fichier de configuration de l'outil [asdf](http://asdf-vm.com) a été créé (`.tool-versions`). Pour utiliser celui-ci, il suffit d'installer `asdf` puis ses plugins correspondants :

```bash
Expand All @@ -29,30 +31,6 @@ L'utilisation de `asdf` est facultative cependant: tout autre moyen d'activer le

> ⚠️ Assurez-vous que les ports **5000** (Hasura) et **5432** (PostgreSQL) soient libres d'écoute. Le cas échéant, vous pouvez changer les ports dans les fichiers de configuration ou d'environnement de l'application.
### ❄️ Nix et direnv (facultatif)

Une configuration nix est disponible via le fichier flake.nix.

En conjonction avec [direnv](https://direnv.net/), cette configuration vous permet d'installer les dépendances du projet de manière isolée. Les outils du projet ne seront disponibles que dans le dossier du projet, dans la bonne version.

Pour utiliser cette configuration :

1. Installer [nix](https://nixos.org/download.html) et [direnv](https://direnv.net/).
2. Aller dans le dossier racine du projet (avec un terminal)
3. Autoriser direnv à fonctionner dans le dossier

```bash
direnv allow
```

Pour vérifier l'installation

```bash
pre-commit --version # pre-commit X.X.X
poetry --version # Poetry (version X.X.X)
node --version # v18.X.X
```

## Étapes

**1/** Récupérer les sources du projet
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,28 @@ La plateforme est développée, maintenue et supervisée par l'équipe "Carnet d

La plateforme est hébergée et opérée en production par les équipes sur Scalingo (https://scalingo.com).

## Architecture
## 🏗️ Architecture

![Architecture applicative du projet](./docs/cdb-architecture.png)
![Architecture cible](./docs/adr/images/CDB_internal_architecture_target.png)

La plateforme Carnet de bord est constituée des briques applicatives suivantes :
- une application cliente SSR en TypeScript / **SvelteKit** et en **Elm** (front-end)
- une instance **Hasura** permettant au client de requêter la base en lecture + écriture (avec gestion des droits et scopes) via GraphQL (back-for-front)
- une base de données **PostgreSQL**
- une API métier en Python / **FastAPI** (back-end)

### Schéma de la base de données
![Scéma de la base](docs/database-schema.png)

## Installation

Le guide d'installation de la plateforme peut être consulté depuis le fichier [INSTALL.md](./INSTALL.md).

## Développement
## 🛠️ Développement

Le guide de développement de la plateforme peut être consulté depuis le fichier [DEVELOPING.md](./DEVELOPING.md).

## Déploiement
## 🚀 Déploiement

Le guide de déploiement en production de la plateforme peut être consulté depuis le fichier [DEPLOY.md](./DEPLOY.md).

Expand All @@ -47,13 +50,13 @@ En complément du présent fichier README, ce dépôt de code inclut d'autres RE
- [backend/README.md](./backend/README.md)
- [e2e/README.md](./e2e/README.md)

## Code de conduite
## ❤️ Code de conduite

L'équipe respecte et applique un code de conduite adapté du [_Contributor Covenant_](https://www.contributor-covenant.org/), version 2.0.

Le code de conduite de l'équipe en charge du projet peut être consulté depuis le fichier [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).

## Licence
## 📄 Licence

Ce logiciel et son code source sont distribués sous licence Apache-2.0.

Expand Down
Loading

0 comments on commit b75f27f

Please sign in to comment.