Installation

Frappe Books is an app for the Frappe Framework. You install it on a Frappe site. Your team then signs in to that site from a browser on a computer or a phone.

All company data stays in the site database. There is no file to download and no .db file to keep.

Requirements

Install with Bench

1. Install Python 3.14 and Bench:

   uv python install 3.14
   uv tool install frappe-bench
   

2. Create a bench on the Frappe develop branch:

   bench init --frappe-branch develop --python "$(uv python find 3.14)" books-bench
   cd books-bench
   

3. Get the app:

   bench get-app https://github.com/frappe/frappe-books
   

4. Create a site. Set --db-type to mariadb, postgres, or sqlite:

   bench new-site books.localhost --db-type mariadb --set-default
   

5. Install the app on the site:

   bench --site books.localhost install-app frappe_books
   

6. Start the bench:

   bench start
   

7. Open http://books.localhost:8000/books and sign in as Administrator.

The setup wizard opens on the first sign-in. To complete it, see Getting Started with Frappe Books.

Update the App

1. Pull the latest version of the app:

   bench update --apps frappe_books
   

2. Run the migration on each site:

   bench --site books.localhost migrate
   

Back Up a Site

Back up the database and the attached files:

bench --site books.localhost backup --with-files

Keep a copy of site_config.json with the backup.