accounting/books
2
0
Fork 0
mirror of https://github.com/frappe/books.git synced 2024-09-19 19:19:02 +00:00
Code Issues Releases Activity
Free desktop accounting software for small-businesses and freelancers.
2,107 Commits 52 Branches 64 Tags 17 MiB
TypeScript 61.6%
Vue 36.1%
JavaScript 1%
HTML 0.9%
CSS 0.3%
Other 0.1%
4614e221b4
Go to file
18alantom 4614e221b4 fix(test): field counts cause of attachments
2022-10-13 17:36:16 +05:30
.github
backend feat: add Attachment type 2022-10-13 16:55:34 +05:30
build
dummy fix: purgeCache, close db 2022-07-30 16:33:09 +05:30
fixtures Update : changed currency_fractuin unti of france 2022-08-28 17:24:54 +02:00
fyo fix: prevent converter errors on duplication 2022-10-13 17:10:28 +05:30
main fix: catch more network errors 2022-09-20 21:17:43 +05:30
models feat: add attachment field to Invs., Pays. and JEs 2022-10-13 17:29:10 +05:30
public
regional
reports incr: remove redundant fields 2022-10-03 11:48:14 +05:30
schemas fix(test): field counts cause of attachments 2022-10-13 17:36:16 +05:30
scripts
src fix(ui): prevent grid collapse 2022-10-13 17:30:58 +05:30
tests
translations Init ko translation 2022-09-30 21:13:42 +09:00
utils incr: add logUnexpected 2022-09-20 22:49:09 +05:30
.eslintrc.js
.git-blame-ignore-revs refactor: move ledgerPosting to models 2022-05-23 16:18:22 +05:30
.gitignore
.prettierignore
babel.config.js
electron-builder.yml
LICENSE
main.ts fix: net::ERR_HTTP2_PROTOCOL_ERROR 2022-08-30 13:43:52 +05:30
META.md
package.json fix(ui): prevent grid collapse 2022-10-13 17:30:58 +05:30
postcss.config.js
README.md Add translator 2022-09-30 21:18:12 +09:00
tailwind.config.js
tsconfig.json
vue.config.js
yarn.lock fix(ui): prevent grid collapse 2022-10-13 17:30:58 +05:30

README.md

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 setup Frappe Books for development and building:

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

# change directory
cd books

# install dependencies
yarn

Development

To run Frappe Books in development mode (with hot reload, etc):

# start the electron app
yarn electron:serve

Build

To build Frappe Books and create an installer:

# start the electron app
yarn electron:build

Note By default the above command will build for your computer's operating system and architecture. To build for other environments (example: for linux from a windows computer) check the Building section at electron.build/cli.

So to build for linux you could use the --linux flag like so: yarn electron:build --linux.

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 can join our telegram group and share your thoughts.
  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. 🙂

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.

Translation Contributors

Language Contributors
French DeepL, mael-chouteau
German DeepL, barredterra
Portuguese DeepL
Arabic taha2002
Catalan Dídac E. Jiménez
Dutch FastAct
Spanish talmax1124
Gujarati dhruvilxcode
Korean Isaac-Kwon

License

GNU Affero General Public License v3.0