Frappe Framework Documentation

Frappe is a full stack, batteries-included, web framework written in Python and Javascript. It is the framework which powers ERPNext. It is pretty generic and can be used to build database driven apps.

Introduction

  1. What is Frappe?
  2. Why Frappe?
  3. Installation

Basics

  1. Architecture
  2. Directory Structure
  3. Apps
  4. Sites
  5. Understanding Doctypes

Desk (Admin UI)

  1. Desk
  2. Users and Permission
  3. Reports
  4. Printing
  5. Portal Pages
  6. Web Forms
  7. Translations

API Reference

  1. Python
    1. Document
    2. Database
  2. Javascript
    1. Form
    2. Controls
    3. Dialog
    4. Page
    5. Server Calls (AJAX)
    6. Common Utilities
  3. REST API
  4. Jinja API

Deployment

  1. Database Migrations
  2. Production Setup

Writing Tests

  1. Server Side Tests
  2. UI Tests

Help

  1. Debugging
  2. Contribution Guidelines