docs: ajouter un README avec guide d'installation #55

Closed
opened 2026-05-14 07:48:29 +00:00 by cedricAbonnel · 0 comments
Owner

Problème

Le dépôt ne contient pas de README.md ni de guide d'installation. Actuellement docs/ couvre l'architecture du cache, le lien magique et quelques notes de développement — mais rien pour bootstrapper une nouvelle instance.

Le constat est apparu en forkant Folio pour sinformersurlatech.fr : les étapes d'installation (prérequis, composer install, création BDD, migrate.php, vhost) ne sont documentées nulle part.

Suggestion

Ajouter un README.md à la racine couvrant :

  • Prérequis (PHP ≥ 8.2, extensions PDO/pgsql, PostgreSQL, Composer, Apache mod_rewrite)
  • Installation pas-à-pas :
    1. git clone + composer install --no-dev
    2. Copier .env.example.env et remplir les variables
    3. createdb <nom> + php database/migrate.php
    4. Configurer le vhost (Apache / Nginx)
    5. Permissions (chown www-data data/, chmod 640 .env)
  • Paramètres du site (data/site_settings.json ou interface admin)
  • Procédure de mise à jour (git pull + migrate.php)
  • Tableau de la structure du projet

J'ai rédigé un README pour sinformersurlatech.fr qui peut servir de base — je peux ouvrir une PR si ça t'intéresse.

## Problème Le dépôt ne contient pas de `README.md` ni de guide d'installation. Actuellement `docs/` couvre l'architecture du cache, le lien magique et quelques notes de développement — mais rien pour bootstrapper une nouvelle instance. Le constat est apparu en forkant Folio pour [sinformersurlatech.fr](https://sinformersurlatech.fr) : les étapes d'installation (prérequis, `composer install`, création BDD, `migrate.php`, vhost) ne sont documentées nulle part. ## Suggestion Ajouter un `README.md` à la racine couvrant : - Prérequis (PHP ≥ 8.2, extensions PDO/pgsql, PostgreSQL, Composer, Apache mod_rewrite) - Installation pas-à-pas : 1. `git clone` + `composer install --no-dev` 2. Copier `.env.example` → `.env` et remplir les variables 3. `createdb <nom>` + `php database/migrate.php` 4. Configurer le vhost (Apache / Nginx) 5. Permissions (`chown www-data data/`, `chmod 640 .env`) - Paramètres du site (`data/site_settings.json` ou interface admin) - Procédure de mise à jour (`git pull` + `migrate.php`) - Tableau de la structure du projet J'ai rédigé un README pour sinformersurlatech.fr qui peut servir de base — je peux ouvrir une PR si ça t'intéresse.
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: cedricAbonnel/folio#55