2
0
mirror of https://github.com/frappe/books.git synced 2024-11-08 14:50:56 +00:00
Free desktop accounting software for small-businesses and freelancers.
Go to file
2022-05-23 16:18:21 +05:30
.github [ImgBot] Optimize images 2022-05-22 19:13:02 +00:00
accounting chore: rename getNewDoc, newDoc 2022-05-23 16:18:21 +05:30
backend incr: update docHandler to not use meta 2022-05-23 16:18:21 +05:30
build [ImgBot] Optimize images 2022-05-22 19:13:02 +00:00
fixtures refactor: t( => t` in *.js 2022-02-16 13:15:33 +05:30
frappe incr: update docHandler to not use meta 2022-05-23 16:18:21 +05:30
main incr: get schemaMap on db handler init 2022-05-23 16:18:21 +05:30
models incr: delete some stuff add typed doc.ts 2022-05-23 16:18:21 +05:30
patches fix: patch to fix journal entry ids 2022-03-15 14:34:58 +05:30
public refactor: mounting behaviour for toasts and app 2022-02-10 17:02:55 +05:30
reports incr: drop unused doctypes 2022-05-23 16:18:21 +05:30
schemas incr: update docHandler to not use meta 2022-05-23 16:18:21 +05:30
scripts fix: reduce misery, simplify regex 2022-02-17 18:01:03 +05:30
server incr: drop unused doctypes 2022-05-23 16:18:21 +05:30
src incr: delete some stuff add typed doc.ts 2022-05-23 16:18:21 +05:30
translations Spanish Translation 2022-05-22 14:52:01 -04:00
utils incr: delete some stuff add typed doc.ts 2022-05-23 16:18:21 +05:30
.eslintrc.js chore: fix eslintrc, remove .vscode launch.json 2022-02-23 11:33:55 +05:30
.gitignore chore: change err_log_creds to log_creds 2022-03-14 12:36:42 +05:30
.prettierignore incr: delete some stuff add typed doc.ts 2022-05-23 16:18:21 +05:30
babel.config.js chore: Migrate project structure to Vue CLI 2019-12-12 23:07:43 +05:30
electron-builder.yml chore: change err_log_creds to log_creds 2022-03-14 12:36:42 +05:30
LICENSE chore: Change license to AGPLv3 2020-01-02 23:58:53 +05:30
main.ts incr: move messages, add DB_ actions 2022-05-23 16:18:21 +05:30
package.json test: start with dbCore tests 2022-05-23 16:18:21 +05:30
postcss.config.js chore: Migrate project structure to Vue CLI 2019-12-12 23:07:43 +05:30
README.md feat: add Catalan translations 2022-04-01 12:19:19 +05:30
tailwind.config.js chore: switch blues 2022-03-01 14:58:21 +05:30
tsconfig.json incr: add DatabaseManager.call 2022-05-23 16:18:21 +05:30
vue.config.js incr: move messages, add DB_ actions 2022-05-23 16:18:21 +05:30
yarn.lock test: start with dbCore tests 2022-05-23 16:18:21 +05:30

Frappe Books logo

GitHub release (latest by date) Platforms Publish

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

frappebooks.com

Frappe Books Preview

Index

[show/hide]
  1. Features
  2. Installation
  3. Development
  4. Contributions and Community
  5. Links
  6. Translation Contributors
  7. 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. If you're a user, you can switch on anonymized telemetry.
  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)

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

Translation Contributors

Language Contributors
French DeepL
German DeepL, barredterra
Portuguese DeepL
Arabic taha2002
Catalan Dídac E. Jiménez

License

GNU Affero General Public License v3.0