Frappe Education Documentation

To set up a production-ready instance of Frappe Education, use the easy-install.py script. This process automates the installation and configuration of the necessary components.

1. Download the installation script:

   wget https://frappe.io/easy-install.py

2. Run the deployment command with your specific configuration:

   python3 ./easy-install.py deploy \
       --project=education_prod_setup \
       --email=your_email.example.com \
       --image=ghcr.io/frappe/education \
       --version=stable \
       --app=education \
       --sitename subdomain.domain.tld

Parameters:

• --email: Your contact email address.
• --sitename: The domain name where the Education module will be hosted.
• --image: The container image to use (ghcr.io/frappe/education).
• --app: The application to deploy (education).

To use this template, clone it into the root folder of an existing Frappe app using degit. This sets up a Vue 3 environment with Vue Router, TailwindCSS, and Frappe UI.

Assuming your app is named todo, follow these steps:

1. Navigate to your app directory.
2. Clone the template into a frontend directory.
3. Install dependencies and start the development server.

cd apps/todo
npx degit NagariaHussain/doppio_frappeui_starter frontend
cd frontend
yarn
yarn dev

To develop locally, you must first have bench installed and a frappe-bench directory configured. Follow these steps:

1. Install ERPNext:

   bench get-app erpnext

2. Install the Education app:

   bench get-app education

3. Create a new site:

   bench new-site education.test

4. Map the site to your localhost:

   bench --site education.test add-to-hosts

5. Install the Education app on the site:

   bench --site education.test install-app education

Accessing the application:

• Main App: http://education.test:8000/education
• Student Portal: http://education.test:8000/student-portal

To prevent CSRFToken errors when using the Vite dev server in a development environment, you must add the ignore_csrf key to your site's site_config.json file.

Note: In production, the csrf_token is automatically attached to the window object in index.html, so this configuration is only required for local development.

"ignore_csrf": 1

When choosing a branch, ensure it is compatible with your Frappe Framework version:

The global_search_doctypes dictionary defines which DocTypes from the Education module are indexed and prioritized in the Frappe global search bar. Each entry is a dictionary containing the doctype and an index value to control search priority.

global_search_doctypes = {
	"Education": [
		{"doctype": "Article", "index": 1},
		{"doctype": "Video", "index": 2},
		# ... other doctypes
	]
}

The MariaDB service in the Docker setup is configured with specific flags to ensure compatibility with Frappe's requirements for character sets and collations.

Key configurations include:

• Character Set: utf8mb4
• Collation: utf8mb4_unicode_ci
• Handshake: --skip-character-set-client-handshake is used to ensure consistent encoding.
• Compatibility: --skip-innodb-read-only-compressed is included as a temporary fix for MariaDB 10.6+ environments.

services:
  mariadb:
    image: mariadb:10.8
    command:
      - --character-set-server=utf8mb4
      - --collation-server=utf8mb4_unicode_ci
      - --skip-character-set-client-handshake
      - --skip-innodb-read-only-compressed
    environment:
      MYSQL_ROOT_PASSWORD: 123

To include custom JavaScript in the header of the Frappe Desk (the administrative interface), use the app_include_js hook. In this module, it is configured to include education.bundle.js.

app_include_js = "education.bundle.js"