Skip to content

Commit 34aca14

Browse files
committed
chore(release): v0.0.4
1 parent 4f2717d commit 34aca14

File tree

2 files changed

+312
-136
lines changed

2 files changed

+312
-136
lines changed

README.md

Lines changed: 125 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -1,183 +1,183 @@
1-
# SophiaHackLab Documentation
1+
# Documentation SophiaHackLab
22

3-
This is the official documentation website for [SophiaHackLab](https://www.shl.contact/), a collaborative hackerspace for engineers, artists, scientists, and entrepreneurs located in Sophia-Antipolis, France.
3+
Le présent document constitue le site web officiel de documentation pour [SophiaHackLab](https://www.shl.contact/), un hackerspace collaboratif regroupant ingénieurs, artistes, scientifiques et entrepreneurs, situé à Sophia-Antipolis, France.
44

5-
Built with [Docusaurus](https://docusaurus.io/), a modern static website generator.
5+
Ce site est développé avec [Docusaurus](https://docusaurus.io/), un générateur de sites web statiques moderne.
66

7-
## Quick Start
7+
## Démarrage rapide
88

99
### Installation
1010

1111
```bash
1212
npm install
1313
```
1414

15-
### Local Development
15+
### Développement local
1616

1717
```bash
1818
npm start
1919
```
2020

21-
This command starts a local development server at `http://localhost:3000` and opens up a browser window. Most changes are reflected live without having to restart the server.
21+
Cette commande lance un serveur de développement local à l'adresse `http://localhost:3000` et ouvre une fenêtre de navigateur à cette adresse. La plupart des modifications sont reflétées instantanément sans nécessiter le redémarrage du serveur.
2222

2323
### Build
2424

2525
```bash
2626
npm run build
2727
```
2828

29-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
29+
Cette commande génère le contenu statique dans le répertoire `build` et peut être déployée via tout service d'hébergement de contenu statique.
3030

31-
## Testing
31+
## Tests
3232

33-
We use [Playwright](https://playwright.dev/) for end-to-end testing across Chromium, Firefox, and WebKit browsers.
33+
[Playwright](https://playwright.dev/) est utilisé pour les tests de bout en bout (end-to-end) sur les navigateurs Chromium, Firefox et WebKit.
3434

35-
### Run E2E Tests (Dev Server)
35+
### Exécution des tests E2E (serveur de développement)
3636

37-
Run tests against the development server:
37+
Exécuter les tests sur le serveur de développement:
3838

3939
```bash
40-
npm start # In one terminal
41-
npm run test:e2e # In another terminal
40+
npm start # Dans un premier terminal
41+
npm run test:e2e # Dans un second terminal
4242
```
4343

44-
### Run Complete Test Suite (Production Build)
44+
### Exécution de la suite complète de tests (build de production)
4545

46-
Build, serve, test, and generate reports in one command:
46+
Build, déploiement, tests et génération de rapports en une seule commande:
4747

4848
```bash
4949
npm run test:local
5050
```
5151

52-
This script will:
53-
1. Build the Docusaurus site
54-
2. Start a local production server
55-
3. Wait for the server to be ready
56-
4. Run Playwright e2e tests
57-
5. Generate JUnit XML and HTML reports
58-
6. Stop the server and display results
52+
Ce script exécute les opérations suivantes:
53+
1. Build du site Docusaurus
54+
2. Démarrage d'un serveur de production local
55+
3. Attente de la disponibilité du serveur
56+
4. Exécution des tests e2e Playwright
57+
5. Génération des rapports JUnit XML et HTML
58+
6. Arrêt du serveur et affichage des résultats
5959

60-
**Test Reports:**
60+
**Rapports de tests:**
6161
- JUnit XML: `test-results/junit.xml`
62-
- HTML Report: `test-results/html/index.html`
62+
- Rapport HTML: `test-results/html/index.html`
6363

64-
### View Test Reports
64+
### Visualisation des rapports de tests
6565

66-
Open the HTML test report in your browser:
66+
Ouvrir le rapport de tests HTML dans votre navigateur:
6767

6868
```bash
6969
npm run test:report
7070
```
7171

72-
## Project Structure
72+
## Structure du projet
7373

7474
```
7575
.
76-
├── docs/ # Documentation markdown files
77-
│ ├── intro.md # Introduction page
78-
│ ├── contributing.md # Contributing guide (in sidebar)
79-
│ ├── test-reports.md # Test reports documentation
80-
│ └── projects/ # Project documentation
76+
├── docs/ # Fichiers markdown de documentation
77+
│ ├── intro.md # Page d'introduction
78+
│ ├── contributing.md # Guide de contribution (dans la sidebar)
79+
│ ├── test-reports.md # Documentation des rapports de tests
80+
│ └── projects/ # Documentation des projets
8181
│ ├── fete_de_la_science/
8282
│ ├── rov/
8383
│ └── triviak/
8484
│ ├── mini/
8585
│ └── real/
86-
├── blog/ # Blog posts (3 SHL articles)
86+
├── blog/ # Articles de blog
8787
│ ├── 2025-01-06-campagne-dons-2025.md
8888
│ ├── 2024-12-15-innovation-hackerspaces.md
8989
│ ├── 2025-01-05-open-talks-rust.md
90-
│ ├── authors.yml # Blog authors
91-
│ └── tags.yml # Blog tags
92-
├── src/ # React components and pages
93-
├── static/ # Static assets
94-
├── tests/ # Playwright e2e tests
90+
│ ├── authors.yml # Auteurs du blog
91+
│ └── tags.yml # Tags du blog
92+
├── src/ # Composants React et pages
93+
├── static/ # Ressources statiques
94+
├── tests/ # Tests e2e Playwright
9595
│ ├── homepage.spec.ts
9696
│ ├── sidebar.spec.ts
9797
│ └── projects.spec.ts
98-
├── scripts/ # Utility scripts
99-
│ └── test-local.sh # Local testing script
100-
├── docusaurus.config.ts # Docusaurus configuration
101-
├── playwright.config.ts # Playwright configuration
102-
├── sidebars.ts # Sidebar configuration (autogenerated)
103-
└── DEPLOYMENT.md # Deployment instructions
98+
├── scripts/ # Scripts utilitaires
99+
│ └── test-local.sh # Script de test local
100+
├── docusaurus.config.ts # Configuration Docusaurus
101+
├── playwright.config.ts # Configuration Playwright
102+
├── sidebars.ts # Configuration de la sidebar (autogénérée)
103+
└── DEPLOYMENT.md # Instructions de déploiement
104104
```
105105

106-
## Deployment
106+
## Déploiement
107107

108-
### GitHub Pages (Automated)
108+
### GitHub Pages (automatisé)
109109

110-
The site is automatically deployed to GitHub Pages when changes are pushed to the `main` branch via GitHub Actions.
110+
Le site est automatiquement déployé sur sur une GitHub Page lors des modifications poussées sur la branche `main` (via GitHub Actions).
111111

112-
**Production URL:** https://sophiahacklab.github.io/docusaurus/
112+
**URL de production:** https://sophiahacklab.github.io/docusaurus/
113113

114-
#### GitHub Actions Workflows
114+
#### Workflows GitHub Actions
115115

116-
We use two automated workflows:
116+
Deux workflows automatisés:
117117

118-
**1. Deploy Workflow** (`.github/workflows/deploy.yml`)
119-
- **Trigger:** Push to `main` branch
120-
- **Steps:**
121-
1. Checkout code
122-
2. Setup Node.js 20
123-
3. Install dependencies
118+
**1. Workflow de déploiement** (`.github/workflows/deploy.yml`)
119+
- **Déclenchement:** Push sur la branche `main`
120+
- **Étapes:**
121+
1. Checkout du code
122+
2. Installation de Node.js 20
123+
3. Installation des dépendances
124124
4. Build Docusaurus
125-
5. Upload build artifact
126-
6. Deploy to GitHub Pages
127-
- **Status:** [![Deploy](https://github.com/SophiaHackLab/docusaurus/actions/workflows/deploy.yml/badge.svg)](https://github.com/SophiaHackLab/docusaurus/actions/workflows/deploy.yml)
128-
129-
**2. E2E Test Workflow** (`.github/workflows/test.yml`)
130-
- **Trigger:** Push to `main`, Pull requests, manual dispatch
131-
- **Steps:**
132-
1. Checkout code
133-
2. Setup Node.js 20 with npm cache
134-
3. Install dependencies with `npm ci`
135-
4. Install Playwright browsers with dependencies
125+
5. Upload de l'artefact de build
126+
6. Déploiement sur GitHub Pages
127+
- **Statut:** [![Deploy](https://github.com/SophiaHackLab/docusaurus/actions/workflows/deploy.yml/badge.svg)](https://github.com/SophiaHackLab/docusaurus/actions/workflows/deploy.yml)
128+
129+
**2. Workflow de tests E2E** (`.github/workflows/test.yml`)
130+
- **Déclenchement:** Push sur `main`, Pull requests, déclenchement manuel
131+
- **Étapes:**
132+
1. Checkout du code
133+
2. Installation de Node.js 20 avec cache npm
134+
3. Installation des dépendances via `npm ci`
135+
4. Installation des navigateurs Playwright avec dépendances
136136
5. Build Docusaurus
137-
6. Run Playwright tests with JUnit, HTML, and list reporters
138-
7. Upload test results (JUnit XML and HTML)
139-
8. Upload screenshots on failure
140-
9. Publish test summary to GitHub
137+
6. Exécution des tests Playwright avec reporters JUnit, HTML et list
138+
7. Upload des résultats de tests (JUnit XML et HTML)
139+
8. Upload des captures d'écran en cas d'échec
140+
9. Publication du résumé des tests sur GitHub
141141
- **Timeout:** 15 minutes maximum
142-
- **Reports:** Available as GitHub Actions artifacts for 30 days
143-
- **Status:** [![Tests](https://github.com/SophiaHackLab/docusaurus/actions/workflows/test.yml/badge.svg)](https://github.com/SophiaHackLab/docusaurus/actions/workflows/test.yml)
142+
- **Rapports:** Disponibles en tant qu'artefacts GitHub Actions pendant 30 jours
143+
- **Statut:** [![Tests](https://github.com/SophiaHackLab/docusaurus/actions/workflows/test.yml/badge.svg)](https://github.com/SophiaHackLab/docusaurus/actions/workflows/test.yml)
144144

145-
#### Repository Settings
145+
#### Paramètres du dépôt
146146

147-
To enable GitHub Pages deployment:
147+
Les GitHub Pages sont activées (projet Open Source):
148148

149-
1. Go to **Settings → Pages**
150-
2. Set **Source** to "GitHub Actions"
151-
3. The site will deploy automatically on the next push
149+
1. Accéder à **Settings → Pages**
150+
2. Définir **Source** sur "GitHub Actions"
151+
3. Le site sera déployé automatiquement au prochain push
152152

153-
### Manual Deployment
153+
### Déploiement manuel (debug)
154154

155-
Using SSH:
155+
Via SSH:
156156

157157
```bash
158158
USE_SSH=true npm run deploy
159159
```
160160

161-
Not using SSH:
161+
Sans SSH:
162162

163163
```bash
164-
GIT_USER=<Your GitHub username> npm run deploy
164+
GIT_USER=<Votre nom d'utilisateur GitHub> npm run deploy
165165
```
166166
167167
## Configuration
168168
169-
### Environment-Based URLs
169+
### URLs basées sur l'environnement
170170

171-
The site uses environment-based configuration for URLs:
171+
Le site utilise une configuration d'URL basée sur l'environnement:
172172

173-
- **Local Development:** `baseURL: '/'` at `http://localhost:3000`
174-
- **GitHub Pages:** `baseURL: '/docusaurus/'` at `https://sophiahacklab.github.io/docusaurus/`
173+
- **Développement local:** `baseURL: '/'` à `http://localhost:3000`
174+
- **GitHub Pages:** `baseURL: '/docusaurus/'` à `https://sophiahacklab.github.io/docusaurus/`
175175

176-
This is automatically detected via the `BUILD_FOR_GITHUB_PAGES` environment variable.
176+
Cette configuration est détectée automatiquement via la variable d'environnement `BUILD_FOR_GITHUB_PAGES`.
177177
178-
### Internationalization
178+
### Internationalisation
179179
180-
The site is configured with French (fr) as the default locale:
180+
Le site est configuré en français (fr) comme locale par défaut:
181181
182182
```typescript
183183
i18n: {
@@ -186,10 +186,10 @@ i18n: {
186186
}
187187
```
188188
189-
### Theme Configuration
189+
### Configuration du thème
190190
191-
**Forced Dark Mode:**
192-
The site uses a custom monochrome dark theme with color mode switching disabled:
191+
**Mode sombre forcé:**
192+
Le site utilise un thème sombre monochrome personnalisé avec commutation du mode couleur désactivée:
193193
194194
```typescript
195195
colorMode: {
@@ -199,14 +199,14 @@ colorMode: {
199199
}
200200
```
201201
202-
**Custom Styling:**
203-
- Ultra-minimal monochrome design with pure black (#000000) backgrounds
204-
- Maximum contrast with white/gray text
205-
- Custom CSS in `src/css/custom.css` for minimalist aesthetic
202+
**Stylisation personnalisée:**
203+
- Design monochrome ultra-minimaliste avec arrière-plans noir pur (#000000)
204+
- Contraste maximum avec texte blanc/gris
205+
- CSS personnalisé dans `src/css/custom.css` pour une esthétique minimaliste
206206
207-
### Mermaid Diagram Support
207+
### Support des diagrammes Mermaid
208208
209-
The site includes Mermaid diagram rendering capabilities via `@docusaurus/theme-mermaid`:
209+
Le site intègre des capacités de rendu de diagrammes Mermaid via `@docusaurus/theme-mermaid`:
210210
211211
```typescript
212212
themes: ['@docusaurus/theme-mermaid'],
@@ -215,51 +215,51 @@ markdown: {
215215
}
216216
```
217217
218-
You can create diagrams directly in markdown using mermaid code blocks.
218+
Il est possible de créer des diagrammes directement dans le markdown en utilisant des blocs de code mermaid.
219219
220220
### Sidebar
221221
222-
The sidebar is automatically generated from the filesystem structure in the `docs/` directory. To customize the order:
222+
La sidebar est automatiquement générée à partir de la structure du système de fichiers dans le répertoire `docs/`. Pour personnaliser l'ordre:
223223

224-
- Use `sidebar_position` in markdown frontmatter
225-
- Add `_category_.json` files in directories
226-
- See [Docusaurus sidebar docs](https://docusaurus.io/docs/sidebar)
224+
- Utiliser `sidebar_position` dans le frontmatter markdown
225+
- Ajouter des fichiers `_category_.json` dans les répertoires
226+
- Consulter la [documentation sidebar de Docusaurus](https://docusaurus.io/docs/sidebar)
227227

228-
## Available Scripts
228+
## Scripts disponibles
229229

230230
| Script | Description |
231231
|--------|-------------|
232-
| `npm start` | Start development server |
233-
| `npm run build` | Build for production |
234-
| `npm run serve` | Serve production build locally |
235-
| `npm run test:e2e` | Run Playwright e2e tests |
236-
| `npm run test:local` | Build, serve, test, and report |
237-
| `npm run test:report` | Open HTML test report |
238-
| `npm run clear` | Clear Docusaurus cache |
239-
| `npm run deploy` | Deploy to GitHub Pages |
232+
| `npm start` | Démarrer le serveur de développement |
233+
| `npm run build` | Build pour la production |
234+
| `npm run serve` | Servir le build de production localement |
235+
| `npm run test:e2e` | Exécuter les tests e2e Playwright |
236+
| `npm run test:local` | Build, servir, tester et générer un rapport |
237+
| `npm run test:report` | Ouvrir le rapport de tests HTML |
238+
| `npm run clear` | Effacer le cache Docusaurus |
239+
| `npm run deploy` | Déployer sur GitHub Pages |
240240

241241
## Blog
242242

243-
The site includes 3 SHL-specific blog articles:
243+
Le site comprend 3 articles de blog spécifiques au SHL:
244244

245-
- **2025 Donation Campaign** - Information about supporting SHL through donations
246-
- **Innovation in Hackerspaces** - How hackerspaces catalyze tech ecosystems
247-
- **Open Talks: Rust** - Event announcement for Rust presentation (January 14, 2025)
245+
- **Campagne de dons 2025** - Informations sur le soutien au SHL via les dons
246+
- **Innovation dans les hackerspaces** - Comment les hackerspaces catalysent les écosystèmes technologiques
247+
- **Open Talks: Rust** - Annonce d'événement pour la présentation Rust (14 janvier 2025)
248248
249-
All blog posts feature SHL branding and are properly tagged for easy navigation.
249+
Tous les articles de blog comportent le branding SHL et sont correctement tagués pour une navigation facilitée.
250250
251-
## Contributing
251+
## Contribuer
252252
253-
Please read [CONTRIBUTING.md](./docs/contributing.md) for details on our code of conduct and the process for submitting pull requests.
253+
Veuillez consulter [CONTRIBUTING.md](./docs/contributing.md) pour les détails concernant notre code de conduite et le processus de soumission des pull requests.
254254
255-
## About SophiaHackLab
255+
## À propos du SophiaHackLab
256256
257-
SophiaHackLab is a community of engineers, artists, scientists, entrepreneurs, and other creative people who share a workspace and socialization space in Sophia-Antipolis, France.
257+
Le SophiaHackLab regroupe des ingénieurs, artistes, scientifiques, entrepreneurs et créatifs, qui partagent un espace de travail et de socialisation à Sophia-Antipolis, France.
258258
259-
- **Website:** https://www.shl.contact/
260-
- **Location:** Space Antipolis, Building 9, Sophia-Antipolis
259+
- **Site web:** https://www.shl.contact/
260+
- **Localisation:** Space Antipolis, Bâtiment 9, Sophia-Antipolis
261261
- **Contact:** [email protected]
262262
263-
## License
263+
## Licence
264264
265-
This project documentation is maintained by SophiaHackLab.
265+
Cette documentation de projet est maintenue par le SophiaHackLab.

0 commit comments

Comments
 (0)