Appe - Installation

1. Mobile App Availability

  • Android – Available as Appe Mobile App (Download link will be provided soon).
  • iOS – Coming Soon.

πŸ‘‰ 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 develop

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 cmake and python3-dev installed.
  • Error: opencv not found β†’ Install libopencv-dev.
  • Permission issues β†’ Try running commands with sudo if required.
  • Bench not recognized β†’ Ensure bench is installed globally (pip install frappe-bench).

6. Help & Support

If you face any issue or need help:

πŸ“§ Email: info@eactivetechnologies.com 🌐 Website: https://eactivetechnologies.com

We’re always happy to help!

Discard
Save
This page has been updated since your last edit. Your draft may contain outdated content. Load Latest Version

On this page

Review Changes ← Back to Content
Message Status Space Raised By Last update on