Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

upd: Readme #1097

Merged
merged 5 commits into from
Jan 21, 2025
Merged

upd: Readme #1097

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
073f50f
upd: readme
AbleKSaju Dec 9, 2024
272bb18
fix: removed collapsed image section and license
AbleKSaju Dec 12, 2024
dbbfc7b
fix: aligned images
AbleKSaju Dec 12, 2024
ce28928
upd: readme
AbleKSaju Jan 21, 2025
6afc69b
fix: reduce logo size
AbleKSaju Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 70 additions & 57 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,75 +1,95 @@
<div align="center" markdown="1">
<br/>

<img src="https://user-images.githubusercontent.com/29507195/207267672-d422db6c-d89a-4bbe-9822-468a55c15053.png" alt="Frappe Books logo" width="384"/>
<img src="https://frappe.io/files/books.png" alt="Frappe Books logo" width="80"/>

---
<br/>

<h1>Frappe Books</h1>

**Modern Accounting Made Simple**

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/frappe/books)](https://github.com/frappe/books/releases)
![Platforms](https://img.shields.io/badge/platform-mac%2C%20windows%2C%20linux-yellowgreen)
[![Publish](https://github.com/frappe/books/actions/workflows/publish.yml/badge.svg)](https://github.com/frappe/books/actions/workflows/publish.yml)

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

[frappe.io/books](https://frappe.io/books/)
</div>

<div align="center">
<img src="https://user-images.githubusercontent.com/29507195/207267857-4ae48890-3fb2-4046-80cf-3256b46c72a0.png" alt="Frappe Books Preview"/>

</div>
<br />
<div align="center">
<a href="https://frappe.io/books">Website</a>
-
<a href="https://docs.frappe.io/books">Documentation</a>
</div>

## Index
## Frappe Books

<details>
<summary><code>[show/hide]</code></summary>
Frappe Books is an open-source accounting software aimed at simplifying financial management for businesses. With its clean and user-friendly interface, it streamlines accounting tasks for small and medium-sized enterprises, offering a seamless solution for modern businesses to manage their finances with ease.

1. [Features](#features)
2. [Installation](#installation)
3. [Development](#development)
4. [Contributions and Community](#contributions-and-community)
5. [Links](#links)
6. [Translation Contributors](#translation-contributors)
7. [License](#license)
<details>
<summary>Screenshots</summary>
<br/>
<img alt="Pos" src="https://github.com/user-attachments/assets/f75116b4-cf5f-45ee-9927-ba380fa56a46" />
<br/><br/>
<img alt="General Ledger" src="https://github.com/user-attachments/assets/58d8bcdf-1576-4008-b010-7054fb64a12d" />
<br/><br/>
<img alt="Profit and Loss" src="https://github.com/user-attachments/assets/11bd67d1-d808-496b-ac4d-ef68c18b9419" />

</details>

## Features
### Motivation

1. Double-entry accounting
1. Point of Sale
1. Invoicing
1. Billing
1. Payments
1. Journal Entries
1. Dashboard
1. Works Offline
1. Financial Reports
- General Ledger
- Profit and Loss Statement
- Balance Sheet
- Trial Balance
Frappe Books addresses a market gap where small businesses face expensive, complex accounting tools. It offers an intuitive, open-source solution that combines simplicity with essential features, empowering businesses to manage finances effectively—even offline.

## Installation
### Key Features

### Via Flatpak
- **Dashboard**: Provides an overview of key financial data and performance metrics.
- **Point of Sale**: Simplifies retail transactions with an integrated POS system for easy sales processing.
- **Works Offline**: Enables users to continue working without an internet connection and sync later.
- **Double-entry accounting**: Ensures accurate financial tracking by recording each transaction in two accounts.
- **Entries**
- **Invoicing**: Allows businesses to create and manage professional invoices effortlessly.
- **Billing**: Billing processes by generating bills and tracking payments.
- **Payments**: Records and tracks payments received and made.
- **Journal Entries**: Records financial transactions in the general ledger with detailed notes and adjustments.
- **Financial Reports**
- **General Ledger**: Centralized record of all financial transactions, providing a comprehensive view of accounts.
- **Profit and Loss Statement**: Summarizes revenues, costs, and expenses to show business profitability.
- **Balance Sheet**: Displays a company’s assets, liabilities, and equity at a specific point in time.
- **Trial Balance**: Verifies the accuracy of accounting records by ensuring that debits and credits are balanced.
<br/>

<a href='https://flathub.org/apps/io.frappe.books'>
<img width='120' alt='Get it on Flathub' src='https://flathub.org/api/badge?locale=en'/>
</a>
### Under the Hood

### Using Homebrew (for MacOS and Linux)
- **Vue.js**: In Frappe Books, Vue.js powers the front-end, enabling a reactive and component-based UI. It ensures seamless interactions and dynamic updates, giving users a modern, responsive experience.

```zsh
brew install --cask frappe-books
```
- **Electron**: Electron is used to package Frappe Books as a standalone desktop application, allowing it to run offline and provide a native-like experience across Windows, macOS, and Linux.

- **SQLite**: Frappe Books uses SQLite as its local database. All financial data, transactions, and configurations are stored securely in an SQLite file on the user's machine.

## Production Setup

### Manual

Download and install the latest release for your platform from the [releases
page](https://github.com/frappe/books/releases) .

## Development
### Using Homebrew (for MacOS and Linux)

```zsh
brew install --cask frappe-books
```

Frappe Books is built on Vue.js and Electron. It is offline by default and uses
a local SQLite file as the database.
### Via Flatpak (Linux)

<a href='https://flathub.org/apps/io.frappe.books'>
<img width='120' alt='Get it on Flathub' src='https://flathub.org/api/badge?locale=en'/>
</a>

## Development Setup

### Pre-requisites

Expand All @@ -95,8 +115,6 @@ cd books
yarn
```

#### Development

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

```bash
Expand Down Expand Up @@ -136,24 +154,17 @@ computer) check the _Building_ section at

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

## Contributions and Community
## Want to Just Try Out or Contribute?

If you want to contribute to Frappe Books, please check our [Contribution Guidelines](https://github.com/frappe/books/blob/master/.github/CONTRIBUTING.md). 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](https://github.com/frappe/books/issues/new) to inform us.
2. You can help us with language support by [contributing translations](https://github.com/frappe/books/wiki/Contributing-Translations).
3. You can join our [telegram group](https://t.me/frappebooks) 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. 🙂
3. If you're an ardent user you can tell us what you would like to see.
4. 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork))

## Links

- [Telegram Group](https://t.me/frappebooks): Used for discussions and decisions regarding everything Frappe Books.
- [GitHub Discussions](https://github.com/frappe/books/discussions): Used for discussions around a specific topic.
- [Frappe Books Blog](https://tech.frappebooks.com/): Sporadically updated dev blog regarding the development of this project.

## Translation Contributors

| Language | Contributors |
Expand All @@ -163,7 +174,7 @@ If you want to contribute code then you can fork this repo, make changes and rai
| Portuguese | [DeepL](https://www.deepl.com/), [Valdir Amaral](https://github.com/valdir-amaral) |
| Arabic | [taha2002](https://github.com/taha2002), [Faridget](https://github.com/faridget) |
| Catalan | Dídac E. Jiménez |
| Dutch | [RijckAlex](https://github.com/RijckAlex) |
| Dutch | [RijckAlex](https://github.com/RijckAlex), [Stan M](https://github.com/stxm) |
| Spanish | [talmax1124](https://github.com/talmax1124), [delbertf](https://github.com/delbertf) |
| Gujarati | [dhruvilxcode](https://github.com/dhruvilxcode), [4silvertooth](https://github.com/4silvertooth) |
| Hindi | [bnsinghgit](https://github.com/bnsinghgit) |
Expand All @@ -173,6 +184,8 @@ If you want to contribute code then you can fork this repo, make changes and rai
| Turkish | Eyuq, [XTechnology-TR](https://github.com/XTechnology-TR) |
| Danish | [Tummas Joensen](https://github.com/slang123) |

## License
## Learn and connect

[GNU Affero General Public License v3.0](LICENSE)
- [Telegram Group](https://t.me/frappebooks): Used for discussions and decisions regarding everything Frappe Books.
- [GitHub Discussions](https://github.com/frappe/books/discussions): Used for discussions around a specific topic.
- [Documentation](https://docs.frappe.io/books): Offaicial documentation for more details.