books/README.md

---

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

frappebooks.com

Index

[show/hide]

1. Features
2. Installation
3. Development
4. Contributions and Community
5. Links
6. License

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

Installation

Download and install the latest release for your platform from the releases page or the download 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

To get the dev environment up and running you need to first set up Node.js version 16.13.1 and npm. For this, we suggest using nvm.

Next, you will need to install yarn.

Clone and Run

Once you are through the Pre-requisites, you can run the following commands to get Frappe Books running in development mode:

# 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

Contributions and Community

There are many ways you can contribute even if you don't code:

1. If you find any issues, no matter how small (even typos), you can raise an issue to inform us.
2. You can help us with language support by contributing translations.
3. You report errors by setting Hide & Auto Report Errors in Settings > System.
4. If you're an ardent user you can tell us what you would like to see.
5. If you have accounting requirements, you can become an ardent user. 🙂
6. You can join our telegram group and share your thoughts.

If you want to contribute code then you can fork this repo, make changes and raise a PR. (see how to)

Links

• Telegram Group: Used for discussions regarding features, issues, changes, etc. This group is also be used to make decisions regarding project direction.
• Project Board: Roadmap that is updated with acceptable latency.
• GitHub Discussions: Used for discussions around a specific topic.
• Frappe Books Blog: Sporadically updated dev blog regarding the development of this project.

License

GNU Affero General Public License v3.0