2020-01-02 17:36:00 +00:00
|
|
|
# Frappe Books
|
|
|
|
|
|
|
|
|
|
Free Desktop book-keeping software for small-businesses and freelancers.
|
|
|
|
|
|
|
|
|
|
<kbd><img src=".github/frappe-books-preview.png" alt="Frappe Books Preview" /></kbd>
|
|
|
|
|
|
|
|
|
|
# Download
|
|
|
|
|
|
|
|
|
|
Download the latest release for your platform from the [releases
|
|
|
|
|
page](https://github.com/frappe/books/releases).
|
|
|
|
|
|
|
|
|
|
# Development
|
|
|
|
|
|
|
|
|
|
Frappe Books is built on [FrappeJS](https://github.com/frappe/frappejs), Vue.js
|
|
|
|
|
and Electron. It is offline by default, and uses a local SQLite file as the
|
|
|
|
|
database.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
### Pre-requisites
|
2019-02-16 07:05:50 +00:00
|
|
|
|
|
|
|
|
Install build essentials
|
|
|
|
|
|
|
|
|
|
Ubuntu
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
apt-get install build-essential python git
|
|
|
|
|
apt-get install libgconf-2-4
|
|
|
|
|
```
|
|
|
|
|
|
2019-07-23 07:47:20 +00:00
|
|
|
MacOS
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
xcode-select --install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You will also need [Xcode App](https://apps.apple.com/in/app/xcode/id497799835?mt=12) from App Store
|
|
|
|
|
|
2020-01-02 17:36:00 +00:00
|
|
|
### Step 1
|
2019-02-16 07:05:50 +00:00
|
|
|
|
2019-07-23 07:47:20 +00:00
|
|
|
Install [Node.js](https://nodejs.org/en/) (version 12.6.0)
|
2019-02-16 07:05:50 +00:00
|
|
|
|
2019-07-23 07:47:20 +00:00
|
|
|
> Tip: The best way to install and manage Node is to install [nvm](https://github.com/nvm-sh/nvm#usage)
|
2019-02-16 07:05:50 +00:00
|
|
|
|
2020-01-02 17:36:00 +00:00
|
|
|
### Step 2
|
2019-02-16 07:05:50 +00:00
|
|
|
|
|
|
|
|
Install `yarn` package manager.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npm install -g yarn
|
2018-01-09 13:40:33 +00:00
|
|
|
```
|
|
|
|
|
|
2020-01-02 17:36:00 +00:00
|
|
|
### Step 3
|
2019-02-16 07:05:50 +00:00
|
|
|
|
2019-07-23 07:47:20 +00:00
|
|
|
Clone this repo
|
2019-02-16 07:05:50 +00:00
|
|
|
|
|
|
|
|
```bash
|
2020-01-02 17:36:00 +00:00
|
|
|
git clone https://github.com/frappe/books.git
|
2019-02-16 07:05:50 +00:00
|
|
|
```
|
|
|
|
|
|
2020-01-02 17:36:00 +00:00
|
|
|
### Step 4
|
2019-02-16 07:05:50 +00:00
|
|
|
|
|
|
|
|
```bash
|
2020-01-02 17:36:00 +00:00
|
|
|
cd books
|
2019-02-16 07:05:50 +00:00
|
|
|
|
|
|
|
|
# Install dependencies
|
|
|
|
|
yarn
|
|
|
|
|
|
|
|
|
|
# Start the electron app
|
2020-01-02 17:36:00 +00:00
|
|
|
yarn electron:serve
|
2019-07-23 07:47:20 +00:00
|
|
|
```
|
