2
0
mirror of https://github.com/frappe/books.git synced 2024-12-24 11:55:46 +00:00
books/README.md
2022-01-26 17:03:48 +05:30

2.4 KiB

Frappe Books logo

GitHub release (latest by date) Platforms Publish

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

Frappe Books Preview

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 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

Due to some yarn.lock issue this won't run, to run it check Issue #315

# 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

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