mirror of
https://github.com/frappe/books.git
synced 2024-11-09 23:30:56 +00:00
chore: minor updates to readme
This commit is contained in:
parent
a1a22898f6
commit
5ef38b62cc
84
README.md
84
README.md
@ -8,13 +8,27 @@
|
||||
![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.
|
||||
|
||||
[frappebooks.com](https://frappebooks.com/)
|
||||
|
||||
<img src=".github/frappe-books-preview.png" alt="Frappe Books Preview" />
|
||||
|
||||
</div>
|
||||
|
||||
## Index
|
||||
|
||||
<details>
|
||||
<summary><code>[show/hide]</code></summary>
|
||||
|
||||
1. [Features](#features)
|
||||
2. [Installation](#installation)
|
||||
3. [Development](#development)
|
||||
4. [Contributions and Community](#contributions-and-community)
|
||||
5. [Links](#links)
|
||||
6. [License](#license)
|
||||
|
||||
</details>
|
||||
|
||||
## Features
|
||||
|
||||
@ -26,16 +40,16 @@ Free Desktop book-keeping software for small-businesses and freelancers.
|
||||
1. Dashboard
|
||||
1. Works Offline
|
||||
1. Financial Reports
|
||||
- General Ledger
|
||||
- Profit and Loss Statement
|
||||
- Balance Sheet
|
||||
- Trial Balance
|
||||
1. Multi-currency Invoicing
|
||||
- General Ledger
|
||||
- Profit and Loss Statement
|
||||
- Balance Sheet
|
||||
- Trial Balance
|
||||
|
||||
## Download
|
||||
## Installation
|
||||
|
||||
Download the latest release for your platform from the [releases
|
||||
page](https://github.com/frappe/books/releases).
|
||||
Download and install the latest release for your platform from the [releases
|
||||
page](https://github.com/frappe/books/releases) or the [download
|
||||
page](https://frappebooks.com/download).
|
||||
|
||||
## Development
|
||||
|
||||
@ -44,33 +58,16 @@ a local SQLite file as the database.
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
1. Install build essentials
|
||||
To get the dev environment up and running you need to first setup Node.js version
|
||||
16.13.1 and npm. For this we suggest using
|
||||
[nvm](https://github.com/nvm-sh/nvm#installing-and-updating).
|
||||
|
||||
Ubuntu
|
||||
|
||||
```bash
|
||||
apt-get install build-essential python git
|
||||
apt-get install libgconf-2-4
|
||||
```
|
||||
|
||||
MacOS
|
||||
|
||||
```bash
|
||||
xcode-select --install
|
||||
```
|
||||
|
||||
You will also need [Xcode App](https://apps.apple.com/in/app/xcode/id497799835?mt=12) from App Store
|
||||
|
||||
2. Install [Node.js](https://nodejs.org/en/). Check the `package.json` file for the node version.
|
||||
> Tip: The best way to install and manage Node is to install [nvm](https://github.com/nvm-sh/nvm#usage)
|
||||
3. Install `yarn` package manager
|
||||
```bash
|
||||
npm install -g yarn
|
||||
```
|
||||
Next, you will need to install [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
|
||||
|
||||
### Clone and Run
|
||||
|
||||
Due to some `yarn.lock` issue this won't run, to run it check [Issue #315](https://github.com/frappe/books/issues/315)
|
||||
Once you are through the Pre-requisites, you can run the following commands to
|
||||
get Frappe Books running in development mode:
|
||||
|
||||
```bash
|
||||
# clone the repository
|
||||
@ -86,14 +83,25 @@ yarn
|
||||
yarn electron:serve
|
||||
```
|
||||
|
||||
## Contributions and Community
|
||||
|
||||
### FAQ
|
||||
There are many ways you can contribute even if you don't code:
|
||||
|
||||
1. Launching electron and nothing displays
|
||||
https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/24#issuecomment-770165389
|
||||
```bash
|
||||
sudo chown root node_modules/electron/dist/chrome-sandbox && sudo chmod 4755 node_modules/electron/dist/chrome-sandbox
|
||||
```
|
||||
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 report errors by setting **Hide & Auto Report Errors** in _Settings > System_.
|
||||
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](https://t.me/frappebooks) 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](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 regarding features, issues, changes, etc. This group is also be used to make decisions regarding project direction.
|
||||
- [Project Board](https://github.com/frappe/books/projects/1): Roadmap that is updated with acceptable latency.
|
||||
- [GitHub Discussions](https://github.com/frappe/books/discussions): Used for discussions around a specific topic.
|
||||
- [Frappe Books Blog](https://frappebooks.com/tech/): Sporadically updated dev blog regarding the developement of this project.
|
||||
|
||||
## License
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user