books/README.md

---

Free Desktop book-keeping software for small-businesses and freelancers.

Features

1. Double-entry accounting
2. Invoicing
3. Billing
4. Payments
5. Journal Entries
6. Dashboard
7. Works Offline
8. Financial Reports
   • General Ledger
   • Profit and Loss Statement
   • Balance Sheet
   • Trial Balance
9. Multi-currency Invoicing

Download

Download the latest release for your platform from the releases page.

Development

Frappe Books is built on FrappeJS, Vue.js and Electron. It is offline by default, and uses a local SQLite file as the database.

Pre-requisites

1. Install build essentials

   Ubuntu

   apt-get install build-essential python git
   apt-get install libgconf-2-4
   

   MacOS

   xcode-select --install
   

   You will also need Xcode App from App Store

2. Install Node.js. Check the package.json file for the node version.

   Tip: The best way to install and manage Node is to install nvm

3. Install yarn package manager

   npm install -g yarn
   

Clone and Run

# clone the repository
git clone https://github.com/frappe/books.git

# change directory
cd books

# install dependencies
yarn

# start the electron app
yarn electron:serve

Developing with FrappeJS

FrappeBooks is based on FrappeJS for managing models and objects. To develop alongside FrappeJS

# clone frappejs
git clone https://github.com/frappe/frappejs.git

# link frappejs
cd frappejs
yarn link

Then in the Frappe books folder.

yarn link frappejs

FAQ

1. Launching electron and nothing displays https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/24#issuecomment-770165389

sudo chown root node_modules/electron/dist/chrome-sandbox && sudo chmod 4755 node_modules/electron/dist/chrome-sandbox

License

GNU Affero General Public License v3.0