Prise en main
Ce chapitre présente Frappe Framework, les prérequis techniques et la procédure d’installation.
OuvrirDocumentation · v15
Frappe Framework
Le framework web full-stack, « batteries incluses », en Python et JavaScript qui propulse ERPNext.
Frappe, qui se prononce « fra-pay », est un framework web full-stack « batteries incluses », écrit en Python et en JavaScript, avec MariaDB comme base de données. C’est le framework qui propulse ERPNext ; il est suffisamment générique pour construire toute application pilotée par une base de données.
Sa particularité est de traiter les métadonnées comme des données. Cela rend la construction des interfaces très simple : Frappe adopte une architecture monolithique et fournit presque tout ce qu’il faut pour une application web moderne, dont une interface d’administration complète, le bureau (Desk), qui gère les formulaires, la navigation, les listes, les menus, les permissions et les pièces jointes.
Cette documentation suit l’organisation de la documentation officielle : prise en main et installation, tutoriel pas à pas, bases du framework (apps, sites, DocTypes, bench), référence des API Python et JavaScript, scripts client et serveur, hooks, portail web et formulaires web, déploiement et tests.
Sommaire
Les chapitres Frappe Framework
Chaque chapitre regroupe des pages courtes, dans l’ordre de lecture conseillé.
Tutoriel
Ce tutoriel construit pas à pas une application complète avec Frappe Framework : installation de bench, création d’une app et d’un site, DocTypes, contrôleurs et scripts de formulaire.
OuvrirBases
Ce chapitre explique les concepts fondamentaux de Frappe Framework : architecture, structure des dossiers, apps, sites, DocTypes, utilisateurs et permissions, assets et configuration.
- Qu’est-ce que Frappe Framework ?
- Pourquoi Frappe Framework ?
- Architecture
- Structure des dossiers
- 8 autres pages
DocTypes
Ce chapitre détaille le fonctionnement des DocTypes : statut des documents, modules, types de champs, nommage, contrôleurs, DocTypes enfants, Single et virtuels, personnalisation et permissions.
OuvrirAPI Python
Ce chapitre est la référence de l’API Python de Frappe Framework : documents, base de données, Query Builder, tâches de fond, temps réel, hooks, API REST, Jinja et utilitaires.
- Temps réel (socket.io)
- Tâches de fond (Background Jobs)
- API Document
- API base de données
- 13 autres pages
API JavaScript
Ce chapitre est la référence de l’API JavaScript de Frappe Framework côté bureau (Desk) : scripts de formulaire, contrôles, listes, pages, dialogues, graphiques, appels serveur et journalisation.
OuvrirLe bureau (Desk)
Ce chapitre présente le bureau (Desk), l’interface d’administration de Frappe : rapports, impression, pièces jointes et scripting.
OuvrirGuides
Ce chapitre introduit la série de guides pratiques de Frappe Framework.
OuvrirGuides : bases
Ces guides couvrent des sujets de base : apps, appels AJAX, chiffrement des sauvegardes, sites, traductions, groupes d’e-mails, sécurité, affectations, notifications et raccourcis clavier.
OuvrirGuides : développement d’applications
Ces guides montrent comment résoudre des besoins courants de développement d’applications Frappe : boutons et actions personnalisés, événements de DocType, tâches de fond, dialogues, OAuth, cache, personnalisations exportées.
- Action personnalisée dans un champ Link
- Exécuter du code sur les événements d’un DocType
- Améliorer un contrôle standard
- Lancer des tâches de fond
- 19 autres pages
Guides : déploiement
Ces guides traitent du déploiement : packages, notifications en cas d’échec de tâches de fond, migration des changements de DocType en production, migrations et connexions sociales.
- Packages
- Notifications par e-mail des tâches de fond en échec
- Migrer les changements de DocType en production
- Migrations
- 1 autre page
Guides : rapports et impression
Ces guides expliquent comment construire des rapports (Query Report, Script Report) et des formats d’impression dans Frappe.
- Récupérer les données d’un autre document dans un format d’impression
- Où trouver les formats d’impression standard
- Créer un Query Report
- Formats d’impression pour les rapports
- 1 autre page
Guides : développement du portail
Ces guides couvrent le développement du portail web de Frappe : pages, ordre, table des matières, pages dynamiques, rôles, Web Forms, générateurs et redirections.
OuvrirGuides : données
Ces guides présentent l’outil de migration de données et l’import de gros volumes de données dans Frappe.
OuvrirGuides : intégration
Ces guides couvrent les intégrations : Google GSuite et Calendar, authentification par jeton, OpenID Connect, webhooks, Social Login Key, OAuth 2 et Frappe comme service OAuth.
- Google GSuite
- Authentification par jeton (token)
- OpenID Connect et connexion sociale Frappe
- Webhooks
- 5 autres pages
Intégration : API REST
Ce chapitre explique comment utiliser l’API REST de Frappe : authentification simple, par jeton ou OAuth 2, listing et manipulation des documents.
- Introduction à l’API REST
- Authentification simple
- Authentification par jeton (token)
- OAuth 2
- 2 autres pages
Guides : paramètres de base de données
Ces guides couvrent les paramètres avancés de base de données : lectures depuis un réplica et configuration de Postgres.
OuvrirGuides : tests automatisés
Ces guides présentent les tests automatisés dans Frappe : tests unitaires, tests d’intégration UI et tests UI avec l’API Frappe.
OuvrirScripts (bureau)
Ce chapitre couvre le scripting depuis le bureau (Desk) : Script client, Script serveur, console système et API de script.
- Script client (Client Script)
- Console système (System Console)
- Script serveur (Server Script)
- API de script
Guides : bureau (Desk)
Ces guides montrent comment personnaliser le bureau (Desk) : formateurs de champs Link, graphiques et utilisation de Vue dans une page.
- Personnalisation du bureau
- Formateur pour les champs Link
- Créer des graphiques
- Utiliser Vue dans une page du bureau
Automatisations
Ce chapitre décrit les automatisations de Frappe : déclencheurs, conditions, étapes, actions et extension des automatisations.
- Automatisations : présentation
- Déclencheurs et conditions
- Étapes et actions
- Étendre les automatisations
Espaces de travail (Workspace)
Ce chapitre décrit les espaces de travail (Workspace) du bureau : personnalisation, blocs et accès.
OuvrirRapports
Ce chapitre couvre les rapports du bureau : Script Report, Query Report, Report Builder et style de l’export Excel.
OuvrirPortail
Ce chapitre couvre le portail web de Frappe : discussions, pages de portail, articles de blog et page Apps.
OuvrirFormulaires web (Web Form)
Ce chapitre décrit les formulaires web (Web Form) : présentation, paramètres, personnalisation et Web Form Request.
OuvrirIntégrations
Ce chapitre couvre les intégrations fournies : RazorPay, Google Drive, LDAP, e-mail Microsoft Office 365 OAuth et OAuth2.
OuvrirBench
Ce chapitre présente bench, l’outil en ligne de commande de Frappe : commandes bench, commandes Frappe et extension de la CLI.
OuvrirBench : référence des commandes
Ce chapitre est la référence des commandes bench : new-site, drop-site, migrate, backup, restore, set-config, execute, trim-database, fichiers PO, etc.
OuvrirBench : guides
Ces guides bench couvrent l’exploitation : domaines personnalisés, HTTPS et Let’s Encrypt, planificateur, limites de site, multi-tenant et mise en production.
- Ajouter des domaines personnalisés à un site
- Configurer HTTPS
- Diagnostiquer le planificateur (Scheduler)
- HTTPS avec Let’s Encrypt
- 3 autres pages
Bench : ressources
Ces ressources décrivent les services en arrière-plan, l’aide-mémoire des commandes et le Procfile de bench.
OuvrirDéploiement
Ce chapitre traite du déploiement : migrations de base de données, mise en production, migrations sans interruption et limitation de débit.
- Migrations de base de données
- Mise en production
- Migrations sans interruption de service
- Limitation de débit (Rate Limiting)
Vidéos
Ce chapitre renvoie vers les tutoriels vidéo de Frappe Framework.
OuvrirÉcrire des tests
Ce chapitre explique comment écrire des tests pour une app Frappe, côté serveur et côté interface.
OuvrirFonctionnalités cachées
Ce chapitre recense des fonctionnalités peu connues du bureau (Desk).
OuvrirAide
Ce chapitre regroupe les sujets d’aide : débogage, contribution à la documentation, profilage et supervision, traductions, journalisation et Event Streaming.
OuvrirGuide : optimisation des performances
Ce chapitre traite de l’optimisation des performances de la base de données : matériel et configuration.
OuvrirPour aller plus loin
Une question sur Frappe Framework ?
Décrivez le cas d’usage. Nous indiquerons la page à lire ou nous l’écrirons.