Documentation

Introduction

Le toolkit repose sur trois briques, volontairement peu nombreuses :

Prérequis

Avant d'installer quoi que ce soit, vérifiez que votre machine dispose des outils suivants.

Vérifier ce qui est déjà installé

$ node -v
v20.11.0
$ npm -v
10.2.4
$ git --version
git version 2.45.1

$ nvm install 20
$ nvm use 20
Now using node v20.11.0 (npm v10.2.4)

Installation

La CLI s'installe une fois pour toutes, en global. Choisissez votre gestionnaire de paquets :

$ npm install -g @genese/cli

$ pnpm add -g @genese/cli

$ yarn global add @genese/cli

Contrôlez ensuite que la commande répond :

$ genese --version
genese/1.4.0 node-v20.11.0

Démarrage rapide

Quatre commandes suffisent pour obtenir un projet qui tourne en local.

1. 1

   Créer le projet

   L'assistant pose quelques questions : nom du projet, structure juridique visée et volets à activer.

   terminalCopier

   $ genese init mon-projet
   ? Nom affiché du projet › Mon Projet
   ? Structure juridique › SAS
   ? Volets à activer › administratif, web, communication
   ✔ Projet créé dans ./mon-projet

2. 2

   Installer les dépendances

   terminalCopier

   $ cd mon-projet
   $ npm install

3. 3

   Lancer le serveur de développement

   Le rechargement est automatique à chaque fichier enregistré.

   terminalCopier

   $ npm run dev
   
   ▲ genese dev
     local    http://localhost:3000
     réseau   http://192.168.1.24:3000
     prêt en 412 ms

4. 4

   Vérifier avant de livrer

   La commande check passe en revue l'accessibilité, les liens morts, les métadonnées et les en-têtes de sécurité.

   terminalCopier

   $ genese check
   ✔ contrastes .............. 0 problème
   ✔ navigation clavier ...... 0 problème
   ✔ liens ................... 34 vérifiés
   ! images .................. 2 sans attribut alt

Structure des fichiers

Un projet fraîchement créé contient uniquement ce qui suit. Rien n'est caché, tout est modifiable à la main.

mon-projet/
├─ public/              fichiers servis tels quels : images, polices, favicon
├─ src/
│  ├─ pages/            une page du site = un fichier .html
│  ├─ styles/           style.css et ses partiels
│  ├─ scripts/          main.js et modules
│  └─ contenus/         textes en markdown, relus par le client
├─ mobile/              projet Flutter, présent si le volet mobile est actif
├─ .env.local           secrets de la machine, jamais versionnés
├─ genese.config.ts     configuration du projet
└─ package.json

Le fichier genese.config.ts

C'est le seul fichier à connaître pour piloter un projet. Il est typé : votre éditeur signale une option mal orthographiée avant même l'exécution.

import { defineConfig } from "@genese/core";
import seo from "@genese/plugin-seo";
import rgpd from "@genese/plugin-rgpd";

export default defineConfig({
  projet: "mon-projet",
  structure: "SAS",
  contact: "contact@mon-projet.fr",

  volets: {
    administratif: true,
    legal: false,
    web: true,
    communication: true,
  },

  suivi: false,

  plugins: [
    seo({ sitemap: true }),
    rgpd({ banniere: "minimale" }),
  ],
});

Référence des options

Variables d'environnement

Les secrets ne vivent jamais dans genese.config.ts. Ils se déclarent dans un fichier .env.local, à la racine du projet.

# Jeton de déploiement, fourni par Genèse
GENESE_TOKEN=gns_live_xxxxxxxxxxxx

# Destinataire du formulaire de contact
CONTACT_TO=contact@mon-projet.fr
SMTP_URL=smtp://utilisateur:motdepasse@smtp.example.net:587

# Exposées au navigateur : uniquement des valeurs publiques
PUBLIC_SITE_URL=https://mon-projet.fr

Commandes

Toutes les commandes acceptent --help pour afficher leurs options.

Exemple : genese status

$ genese status
projet ............ mon-projet
environnement ..... production
dernier build ..... il y a 2 jours
✔ certificat TLS .... valide 74 jours
✔ sauvegardes ....... 7 versions conservées

Plugins

Un plugin s'installe comme n'importe quel paquet, puis se déclare dans la configuration.

$ npm install @genese/plugin-seo @genese/plugin-rgpd

$ pnpm add @genese/plugin-seo @genese/plugin-rgpd

$ yarn add @genese/plugin-seo @genese/plugin-rgpd

Mise en ligne

La compilation produit un site statique : il peut être servi par n'importe quel hébergeur, sans base de données ni processus permanent.

$ genese build
✔ 28 pages compilées
✔ images optimisées .... 1,8 Mo économisés
  sortie ............... dist/ (612 Ko)

$ genese deploy --env production
▲ en ligne : https://mon-projet.fr

Ce que nous exigeons en production

Dépannage

$ npm config get prefix
/Users/moi/.npm-global
$ echo 'export PATH="$(npm config get prefix)/bin:$PATH"' >> ~/.zshrc

$ npm config set prefix ~/.npm-global
$ npm install -g @genese/cli

Support

Une question qui n'est pas couverte ici, un comportement inattendu, une demande d'accès : écrivez-nous, nous répondons sous 48 heures ouvrées.