Appe - Installation
1. Mobile App Availability
Right now, developers and businesses can also set up Appe inside their own Frappe/ERPNext instance using the instructions below.
2. System Requirements
Before installing, make sure your system meets these requirements:
-
Operating System: Ubuntu 20.04 / 22.04 (recommended)
-
Python: v3.10 or later
-
Frappe Framework: v15.0.0 or later (installed & managed via
bench) -
Node.js: v18+
-
Redis & MariaDB (default Frappe stack)
3. Dependencies
Appe uses Face Recognition Service for certain features. For this, the following dependencies are required:
dependencies = [
# "frappe~=15.0.0" # Installed and managed by bench.
"face-recognition",
"numpy",
"pillow",
"dlib",
"opencv-contrib-python"
]
What these libraries do:
-
face-recognition → Detect and recognize faces
-
numpy → Mathematical operations for face data
-
pillow → Image processing (resize, convert, etc.)
-
dlib → Core machine learning + facial recognition models
-
opencv-contrib-python → Advanced computer vision support
Note: Some of these libraries (like dlib) require CMake and other system-level packages.
4. Installation Steps
Follow these steps to install Appe in your Frappe environment:
Step 1: Navigate to your bench directory
cd $PATH_TO_YOUR_BENCH
Example:
cd ~/frappe-bench
Step 2: Install system-level dependencies
Install CMake (required for compiling dlib and face-recognition):
sudo apt update
sudo apt install cmake
Step 3: Get Appe app from GitHub
Clone Appe into your apps folder using bench get-app:
bench get-app https://github.com/eactive-tech/appe.git --branch version-15
Step 4: Install Appe into your Frappe site
bench install-app appe
Example (if your site name is mysite.local):
bench --site mysite.local install-app appe
Step 5: Build and Restart Bench
After installing, rebuild your assets and restart bench:
bench build
bench restart
Step 6: Verify Installation
Log in to your site, go to Installed Apps and check if Appe is listed. 
5. Common Issues & Fixes
-
Error: dlib not compiling → Make sure you have
cmakeandpython3-devinstalled. -
Error: opencv not found → Install
libopencv-dev. -
Permission issues → Try running commands with
sudoif required. -
Bench not recognized → Ensure bench is installed globally (
pip install frappe-bench).