@solidpepper/solidpepper-solidreviewer 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# SolidReviewer
|
|
2
|
+
|
|
3
|
+
Bienvenue dans le projet **SolidReviewer**, un outil moderne d'annotation, de revue de documents et d'épreuves de mise en page basé sur Angular et exposé sous forme de Web Component autonome.
|
|
4
|
+
|
|
5
|
+
## Démarrer l'application
|
|
6
|
+
|
|
7
|
+
Pour lancer l'application en mode développement (sur votre machine locale) :
|
|
8
|
+
|
|
9
|
+
```shell
|
|
10
|
+
npm run start:reviewer
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
_(Cette commande exécute `ng serve solidreviewer-app --port 4201`)_
|
|
14
|
+
|
|
15
|
+
Une fois le serveur démarré, ouvrez votre navigateur à l'adresse : [http://localhost:4201/](http://localhost:4201/)
|
|
16
|
+
Le projet se rechargera automatiquement à chaque modification du code source.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Compiler et Packager pour la Production
|
|
21
|
+
|
|
22
|
+
Le projet est conçu pour être packagé sous forme de librairie réutilisable (et distribué au format npm `.tgz`).
|
|
23
|
+
|
|
24
|
+
Pour préparer et builder manuellement le projet, suivez les étapes ci-dessous :
|
|
25
|
+
|
|
26
|
+
### Étapes manuelles de build :
|
|
27
|
+
|
|
28
|
+
1. **Mettre à jour la version** :
|
|
29
|
+
Dans le fichier `package.json` de la librairie (`projects/solidpepper-solidreviewer/package.json`), mettez à jour le numéro de `"version": "x.y.z"`.
|
|
30
|
+
|
|
31
|
+
2. **Compiler le CSS Tailwind** :
|
|
32
|
+
Le Reviewer utilise Tailwind CSS en Shadow DOM. Pour que l'ensemble des règles utilitaires et thèmes DaisyUI soient compilés dans le composant, lancez la **commande magique** depuis la racine du monorepo (`solidpepper-library`) :
|
|
33
|
+
|
|
34
|
+
```shell
|
|
35
|
+
npx tailwindcss -c ./tailwind.config.js -i ./projects/solidpepper-solidreviewer/src/app/app.component.scss -o ./projects/solidpepper-solidreviewer/src/app/compiled-tailwind.css --minify
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
3. **Builder le projet Angular** :
|
|
39
|
+
Depuis la racine du monorepo (`solidpepper-library`), compilez la librairie en mode production :
|
|
40
|
+
|
|
41
|
+
```shell
|
|
42
|
+
npx ng build solidpepper-solidreviewer --configuration production
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
_Les fichiers compilés se placeront automatiquement dans le dossier `dist/solidpepper-solidreviewer/`._
|
|
46
|
+
|
|
47
|
+
4. **Générer le paquet npm local (`.tgz`)** :
|
|
48
|
+
Se déplacer dans le dossier de build et créer l'archive tarball :
|
|
49
|
+
|
|
50
|
+
```shell
|
|
51
|
+
cd dist/solidpepper-solidreviewer
|
|
52
|
+
npm pack
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
_Cela génère un fichier `.tgz` (ex: `solidpepper-solidpepper-solidreviewer-0.0.1.tgz`) prêt à être référencé dans l'application principale (ex: `Nude`)._
|
|
56
|
+
|
|
57
|
+
## Architecture et Structure du Projet
|
|
58
|
+
|
|
59
|
+
Voici un guide pour vous repérer dans la structure du projet `projects/solidpepper-solidreviewer` :
|
|
60
|
+
|
|
61
|
+
### Point d'entrée & Web Component
|
|
62
|
+
|
|
63
|
+
- **`src/main.ts`** : Initialise l'application standalone et définit le Web Component `<solid-reviewer>` via `@angular/elements`.
|
|
64
|
+
- **`src/public-api.ts`** : Exporte `SolidReviewerComponent` et les services publics comme `SvgCacheService`.
|
|
65
|
+
|
|
66
|
+
### Composants Principaux (`src/app/`)
|
|
67
|
+
|
|
68
|
+
- **`app.component.ts` / `.html` / `.scss`** : Composant hôte encadreur (`<solid-reviewer>`). Il est configuré en **Shadow DOM** (`ViewEncapsulation.ShadowDom`) pour isoler hermétiquement ses styles des applications hôtes.
|
|
69
|
+
- **`components/reviewer-toolbar.component.ts`** : En-tête supérieur avec commandes globales (bascule de barre latérale, mode commentaires, navigation, utilisateur et déconnexion).
|
|
70
|
+
- **`components/reviewer-sidebar.component.ts`** : Panneau latéral gauche affichant la grille dynamique des vignettes de pages.
|
|
71
|
+
- **`components/reviewer-comments.component.ts`** : Panneau latéral droit de gestion et fil de discussion des commentaires / annotations.
|
|
72
|
+
- **`components/reviewer-floating-toolbar.component.ts`** : Outils de navigation rapide et de zoom sur le côté du workspace.
|
|
73
|
+
- **`components/reviewer-correction-bar.component.ts`** : Barre flottante d'outils d'annotation (point, dessin à main levée, rectangles, lignes, effaceur).
|
|
74
|
+
- **`components/global-loader.component.ts`** : Écran de chargement animé avec gestion des erreurs et messages d'attente.
|
|
75
|
+
|
|
76
|
+
### Services & Modèles (`src/app/services/`)
|
|
77
|
+
|
|
78
|
+
- **`svg-cache.service.ts`** : Service d'optimisation du chargement et de la mise en cache (sessionStorage / mémoire) des SVG de chaque page du document.
|
|
79
|
+
- **`translation.service.ts`** : Gestion i18n multilingue (Français, Anglais, Espagnol).
|
|
80
|
+
- **Directives (`src/app/directives/page-intersection.directive.ts`)** : IntersectionObserver optimisé pour la détection dynamique de la page visible lors du défilement.
|
|
81
|
+
|
|
82
|
+
## Remarques sur le Style et le Shadow DOM
|
|
83
|
+
|
|
84
|
+
- **Encapsulation Shadow DOM** : `solid-reviewer` isole complètement ses éléments DOM et son thème CSS.
|
|
85
|
+
- **Tailwind CSS & DaisyUI** : Les utilitaires et variables de thème sont intégrés dans le bundle du Shadow DOM, garantissant zéro conflit CSS avec l'application hôte.
|