Updated the README

This commit is contained in:
Pontoporeia
2026-04-29 20:47:11 +02:00
parent 89de6dd748
commit 0628efbba3

View File

@@ -1,6 +1,6 @@
# XAMXAM
(Anciennement *[Posterg](https://wiki.erg.be/m/#Posterg)*
(Anciennement *[Posterg](https://wiki.erg.be/m/#Posterg))*
Répertoire des travaux de fin d'études de l'[ERG](https://erg.be) (École de Recherche Graphique).
@@ -12,14 +12,29 @@ Répertoire des travaux de fin d'études de l'[ERG](https://erg.be) (École de R
## Development
```bash
just setup # first-time: installs dev dependencies
just serve # http://localhost:8000 (public) and /admin/
just test # run test suite
```
Admin credentials in development are set via `config/admin_credentials.php`
(see `config/admin_credentials.example.php`).
### MacOS
Logiciels:
- un IDE pour éditer → VSCode
- git (ou une interface graphique) pour partager les modifications → git-gui (officiel) ou Github Desktop
- un server web avec PHP pour visualiser le project dans le navigateur → MAMP
### Workflow
0. Faire un changement dans ton IDE
1. Démarrer le site via MAMP, en sélectionnant le dossier `public`
2. Vérifier que ça marche sur le site en local, depuis ton navigateur
3. Une fois qu'un changement spécifique est fait, `commit` les changements sur les fichiers qui sont relatif à ce changement
4. Vérifier que vous avez syncroniser avec le `remote``pull` + `rebase` ! pas merge
5. `push` les changements vers le remote
```bash
just serve # http://localhost:8000 (public) and /admin/
```
## Deployment
@@ -65,23 +80,4 @@ ssh posterg "sudo bash /tmp/manage-admin-users.sh"
- Rate limiting on public search (`src/RateLimit.php`)
- See `nginx/docs/SECURITY_HEADERS.md` for security headers reference
## Mise en place Dev
### MacOS
Logiciels:
- un IDE pour éditer → VSCode
- git (ou une interface graphique) pour partager les modifications → git-gui (officiel) ou Github Desktop
- un server web avec PHP pour visualiser le project dans le navigateur → MAMP
### Workflow
0. Faire un changement dans ton IDE
1. Démarrer le site via MAMP, en sélectionnant le dossier `public`
2. Vérifier que ça marche sur le site en local, depuis ton navigateur
3. Une fois qu'un changement spécifique est fait, `commit` les changements sur les fichiers qui sont relatif à ce changement
4. Vérifier que vous avez syncroniser avec le `remote``pull` + `rebase` ! pas merge
5. `push` les changements vers le remote