Skip to content

Commit c9ef0c3

Browse files
committed
chore: update dependencies and improve README documentation
- Upgraded the 'turbo' package from version 2.3.3 to 2.9.15 for enhanced performance and features. - Updated the package manager version from Yarn 1.22.19 to 1.22.22 for better compatibility and stability. - Revised the README to clarify project structure, enhance descriptions, and improve formatting for better readability.
1 parent 1a71fa6 commit c9ef0c3

2 files changed

Lines changed: 79 additions & 9 deletions

File tree

README.md

Lines changed: 77 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<p align="center">
22
<a href="https://libertech-fr.github.io/sesame-orchestrator" target="blank"><img src="./static/sesame-logo.svg" width="200" alt="Sesame Logo" /></a>
33
</p>
4-
<p align="center">Sésame ochestrator - Synchronisation d'Identités Multi-sources</p>
4+
<p align="center">Sésame Orchestrator — synchronisation d’identités multi-sources</p>
55
<p align="center">
66
<img alt="GitHub all releases" src="https://img.shields.io/github/downloads/libertech-fr/sesame-orchestrator/total">
77
<img alt="GitHub" src="https://img.shields.io/github/license/libertech-fr/sesame-orchestrator">
@@ -11,11 +11,81 @@
1111
<br>
1212

1313
## Description
14-
Sésame est une application open source conçue pour faciliter la synchronisation d'identités entre différentes sources de données, y compris des bases de données, des annuaires LDAP/Active Directory et des applications tierces, vers des serveurs OpenLDAP ou Active Directory. Le projet se compose de deux modules principaux : l'orchestrateur et le démon.
15-
## Sesame Orchestrateur
16-
API du projet SESAME
17-
## Architecture du projet
18-
[Figma](https://www.figma.com/file/OplQ0tHFHS5rFz5K6OCgEd/Sesame?type=whiteboard&node-id=0%3A1&t=ZiPEDwJPp0id8frN-1)
14+
Sésame est une application open source conçue pour faciliter la synchronisation d’identités entre différentes sources (bases de données, annuaires LDAP/Active Directory, applications tierces) vers des annuaires cibles (OpenLDAP / Active Directory).
15+
16+
Ce dépôt (`sesame-orchestrator`) est un **monorepo Node.js/TypeScript** basé sur **Yarn workspaces** et **Turbo**, qui contient :
17+
18+
- **`apps/api`** : API backend en **NestJS**
19+
- **`apps/web`** : frontend en **Nuxt 3** (SPA, `ssr: false`)
20+
21+
## Architecture
22+
- **Maquette / workshops** : [Figma](https://www.figma.com/file/OplQ0tHFHS5rFz5K6OCgEd/Sesame?type=whiteboard&node-id=0%3A1&t=ZiPEDwJPp0id8frN-1)
1923

2024
## Documentation
21-
[ Aller à la documentation](https://libertech-fr.github.io/sesame-doc/)
25+
[Aller à la documentation](https://libertech-fr.github.io/sesame-doc/)
26+
27+
## Prérequis
28+
- **Node.js** (version compatible avec le projet) et **Yarn**
29+
- (Optionnel) **Docker** si vous utilisez le `Makefile` pour les bases de données / l’environnement de dev
30+
31+
## Démarrage rapide
32+
Installer les dépendances à la racine du monorepo :
33+
34+
```bash
35+
yarn install
36+
```
37+
38+
### Lancer en développement
39+
Depuis la racine :
40+
41+
```bash
42+
yarn start:dev
43+
```
44+
45+
Ou application par application :
46+
47+
```bash
48+
# API (NestJS)
49+
yarn workspace @libertech-fr/sesame-orchestrator_api start:dev
50+
51+
# Web (Nuxt 3)
52+
yarn workspace @libertech-fr/sesame-orchestrator_web start:dev
53+
```
54+
55+
### Qualité & build
56+
57+
```bash
58+
yarn lint
59+
yarn build
60+
```
61+
62+
Ou ciblé :
63+
64+
```bash
65+
yarn workspace @libertech-fr/sesame-orchestrator_api lint
66+
yarn workspace @libertech-fr/sesame-orchestrator_web lint
67+
```
68+
69+
### Workflow Docker (optionnel)
70+
Le dépôt fournit aussi un `Makefile` pour un workflow local :
71+
72+
```bash
73+
make dbs
74+
make dev
75+
make stop
76+
```
77+
78+
## Structure du dépôt
79+
80+
```text
81+
sesame-orchestrator/
82+
├── apps/
83+
│ ├── api/ # Backend NestJS
84+
│ └── web/ # Frontend Nuxt 3 (srcDir: src)
85+
├── packages/ # Packages partagés (si présents)
86+
├── turbo.json
87+
└── Makefile
88+
```
89+
90+
## Sécurité
91+
Pour signaler une vulnérabilité, voir `SECURITY.md`.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"console": "yarn workspace @libertech-fr/sesame-orchestrator_api console"
4040
},
4141
"devDependencies": {
42-
"turbo": "^2.3.3"
42+
"turbo": "^2.9.15"
4343
},
44-
"packageManager": "yarn@1.22.19"
44+
"packageManager": "yarn@1.22.22"
4545
}

0 commit comments

Comments
 (0)