2
0
mirror of https://github.com/frappe/books.git synced 2024-07-23 07:40:22 +00:00
Free desktop accounting software for small-businesses and freelancers.
Go to file
2024-04-15 16:40:52 +05:30
.github Merge pull request #801 from frappe/pr-751-electron-update 2024-01-23 10:50:54 -08:00
backend bumped version number and fixed patch 2024-02-07 20:12:30 -08:00
build Fixed linting for PR 843 2024-02-11 16:09:35 -08:00
dummy fix(ux): hide get started in demo 2023-08-24 17:14:14 +05:30
fixtures fix: add suriname currency and locale 2023-09-07 09:31:37 +05:30
fyo fix: expectedAmount calculation 2023-12-04 14:42:57 +05:30
main Fixing printToPDF from electron window 2024-01-29 19:13:14 -08:00
models Fix issue : Purchase Payment Bug on Both Party #860 2024-03-01 12:50:31 -08:00
regional incr: display gstr reports 2022-05-23 16:18:23 +05:30
reports fix(reports): Allow multiple root account to have the same type 2023-12-05 21:38:25 +01:00
schemas chore: validate and lint typescript 2024-01-08 21:56:03 +01:00
scripts fix: use knex for checking values 😔 2023-07-13 11:12:43 +05:30
src Merge pull request #847 from akshayitzme/fix-pos-barcode-field 2024-03-02 18:22:12 -08:00
templates fix(ux): space between label 2023-06-02 13:06:31 +05:30
tests feat: enable custom fields 2023-08-03 13:18:14 +05:30
translations update arabic translation 2024-02-01 23:17:20 +01:00
uitest fix(ux): remove file selection on create 2023-07-11 13:43:32 +05:30
utils fix(ux): remove file selection on create 2023-07-11 13:43:32 +05:30
.eslintrc.js Fixed formatting 2024-01-24 19:11:31 -08:00
.git-blame-ignore-revs chore: blame ignore formatting changes 2023-06-27 13:11:54 +05:30
.gitignore Add regional schemas for Switzerland. 2023-11-28 22:14:35 +01:00
.prettierignore Changed how datetime was fixed for various timezones 2024-02-01 15:54:46 -08:00
colors.json chore: fix sidebar bg 2023-09-01 14:01:27 +05:30
electron-builder-config.mjs Fixed linting for PR 843 2024-02-11 16:09:35 -08:00
electron-builder.yml.disabled Updating electron-builder to a ts file 2024-01-24 19:03:04 -08:00
LICENSE chore: Change license to AGPLv3 2020-01-02 23:58:53 +05:30
main.ts fix: version on develop 2023-07-11 11:02:41 +05:30
META.md incr: add GeneralLedger business logic 2022-05-23 16:18:23 +05:30
package.json bumped version number and fixed patch 2024-02-07 20:12:30 -08:00
postcss.config.js chore: format files using prettier 2023-06-27 13:11:15 +05:30
README.md chore: Update with looking for maintainer 2024-04-15 16:40:52 +05:30
tailwind.config.js refactor: move colors to json 2023-06-20 17:50:20 +05:30
tsconfig.json chore: bump lint dependencies 2023-06-21 13:35:42 +05:30
vite.config.ts chore: format files using prettier 2023-06-27 13:11:15 +05:30
yarn.lock Merge pull request #857 from frappe/dependabot/npm_and_yarn/ip-1.1.9 2024-03-02 18:23:09 -08:00

Important

Frappe Books is looking for a maintainer, please view #775 for more info.

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.14.0 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 dev

Note: First Boot

When you run yarn dev electron will run immediately but the UI will take a couple of seconds to render this because of how dev mode works. Each file is individually served by the dev server. And there are many files that have to be sent.

Note: Debug Electron Main Process

When in dev mode electron runs with the --inspect flag which allows an external debugger to connect to port 5858. You can use chrome for this by visiting chrome://inspect while Frappe Books is running in dev mode.

See more here.

Build

To build Frappe Books and create an installer:

# start the electron app
yarn build

Note: Build Target 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 build --linux.

Contributions and Community

If you want to contribute to Frappe Books, please check our Contribution Guidelines. 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)

  • Telegram Group: Used for discussions and decisions regarding everything Frappe Books.
  • 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, joandreux
German DeepL, barredterra, promexio, C2H6-383
Portuguese DeepL
Arabic taha2002, Faridget
Catalan Dídac E. Jiménez
Dutch FastAct
Spanish talmax1124, delbertf
Gujarati dhruvilxcode, 4silvertooth
Korean Isaac-Kwon
Simplified Chinese wcxu21, wolone
Swedish papplo
Turkish Eyuq, XTechnology-TR

License

GNU Affero General Public License v3.0