Documentation
Point d'entrée de la documentation de @fraza/core, découverte, démarrage, guides, référence, architecture et contribution.
Fraza est un starter kit Next.js avec un back-office modulaire, conçu au Québec. Il livre en une commande ce qu'une application d'entreprise met des semaines à écrire : comptes et connexion, rôles et permissions, interface d'administration, courriels, fichiers, paiements, mise en production.
L'admin est extensible : on y greffe ce qu'on veut, sans modifier le core. Ce qui reste à écrire, c'est votre projet.
Qu'est-ce que Fraza développe cette page en trois minutes de lecture.
Par où commencer
| Vous voulez | Aller à |
|---|---|
| Comprendre ce que c'est, sans rien installer | Découverte, quatre pages à lire dans l'ordre. |
| Monter un projet et le voir tourner | Installation. |
| Résoudre un besoin précis | Guides, un cas d'usage par page. |
| Trouver une signature, une option, une variable | Référence. |
Comment lire cette documentation
Elle est organisée en sept sections :
| Section | Contenu |
|---|---|
| Découverte | Ce qu'est la plateforme, son vocabulaire, son fonctionnement et ce qu'elle permet de construire. Sans installation. |
| Démarrage | Parcours pas à pas, de l'installation au premier module. À lire dans l'ordre. |
| Guides | Un cas d'usage par page. À lire au besoin. |
| Référence | Détail technique de chaque module, fonction, CLI et variable d'environnement. |
| Architecture | Principes, frontières serveur/client, build, sécurité, design system. |
| Contribution | Conventions de code, de rédaction, de commit et procédure de publication. |
| Modules | Usage des modules officiels, gratuits sous @fraza/module-* et Pro sous @fraza-pro/module-*, installation, configuration et API. |
Chaque section a un index.md qui sert de table des matières.
Où trouver cette documentation
Elle vit dans le dépôt sous docs/, et elle est livrée dans le package npm sous node_modules/@fraza/core/dist/docs/. Un projet qui installe @fraza/core a donc la documentation de la version exacte qu'il utilise, hors ligne.
Prérequis
- Node.js 20 ou plus (imposé par le SDK Resend v6, livré quel que soit le fournisseur de courriel actif).
- PostgreSQL 14 ou plus.
- Next.js 14 ou plus, React 19.
- Pour un module Pro seulement, un compte sur le registre npm
https://registry.fraza.ca/. Le core et les modules gratuits s'installent sans compte.
Conventions de cette documentation
- Le contenu est en français, le code en anglais. Voir Langue.
- Chaque page porte un frontmatter
title/description. - Les chemins
src/...désignent le dépôt@fraza/core. Les cheminsapp/...désignent le projet consommateur généré parnpx @fraza/start. - Les exemples supposent un projet déjà structuré par
@fraza/start.
Signaler une faille de sécurité
Ne pas ouvrir d'issue publique. Voir SECURITY.md à la racine du dépôt.
Licence
Le core et les modules de base (Pages, Posts, Médias, Formulaires) sont sous licence MIT, au sein de Fraza Libre. Les modules Facturation, Rendez-vous et Fichiers sont distribués sous la licence Fraza Pro, une licence par projet en production. Chaque paquet porte sa licence dans son fichier LICENSE. Le modèle et ses conséquences sur le code sont expliqués dans Licence et propriété.