Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/budgetzero/budgetzero
Open-source, self-hosted, zero-based budgeting.
https://github.com/budgetzero/budgetzero
budgeting cloud-sync envelope-budget envelope-budgeting free offline open-source transactions ynab
Last synced: 2 months ago
JSON representation
Open-source, self-hosted, zero-based budgeting.
- Host: GitHub
- URL: https://github.com/budgetzero/budgetzero
- Owner: budgetzero
- License: agpl-3.0
- Created: 2021-01-04T16:52:36.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T22:31:23.000Z (3 months ago)
- Last Synced: 2024-10-30T00:44:54.742Z (3 months ago)
- Topics: budgeting, cloud-sync, envelope-budget, envelope-budgeting, free, offline, open-source, transactions, ynab
- Language: Vue
- Homepage: https://app.budgetzero.io
- Size: 4.81 MB
- Stars: 622
- Watchers: 9
- Forks: 44
- Open Issues: 66
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - budgetzero/budgetzero - Open-source, self-hosted, zero-based budgeting. (open-source)
README
# 
[](https://app.netlify.com/sites/budgetzero/deploys)
budgetzero is a free, open-source, privacy-friendly, offline-first budgeting system.
Use at [budgetzero.io](https://app.budgetzero.io), [download the desktop apps](https://github.com/budgetzero/budgetzero/releases/latest) or self-host on your own server. Zero ads, zero trackers, just budgeting.
:warning: budgetzero is under active development and considered an alpha version. You may encounter significant bugs and breaking changes. Feel free to file an issue! :warning:
# Features
:heavy_check_mark: Zero-based 'envelope' budgeting
:heavy_check_mark: Offline-first storage. NOTE: All data is stored in the browser and may be lost if you clear the browser's data.
:heavy_check_mark: Import Transactions (OFX, QFX, CSV)
:heavy_check_mark: Carry negative balances into next month
:heavy_check_mark: Privacy-focused. Zero trackers & zero analytics.
# Getting Started
There's multiple ways to use budgetzero.
1. On the official [app.budgetzero.io](https://app.budgetzero.io) page.
2. Installing the desktop app (Windows or Mac). [Download here](https://github.com/budgetzero/budgetzero/releases/latest)
3. Self host the web app. You can either deploy the docker image or build and host the static files on your own webserver. See deployment section below for more details.
# :warning: Known Issues (being worked on)
- UI Inconsistencies (pop-up boxes, colors, etc)
- Performance not tested for extremely large budgets (thousands of transactions)
- Transfer transactions work but may be a bit buggy
- Find a bug? Please [file an issue!](../../issues)
# Roadmap
[Current development board](https://github.com/budgetzero/budgetzero/projects/1)
- [ ] Reports - started!
- [ ] Cloud Sync through budgetzero.io (coming soon)
- **_Interested in Cloud Sync?_** [Sign up to be notified when available!](https://app.budgetzero.io/login)
- [ ] Self-hosted sync server (coming soon)
- [ ] Cross-platform desktop applications (Windows, Mac, Linux)
- [ ] Multi-month view
- [ ] Payee management
# Deployment
## Docker
```
docker pull budgetzero/budgetzero:latest
```
Then run with
```
docker run -d -p :8080 --name budgetzero budgetzero/budgetzero
```
Example:
```
docker run -d -p 8080:8080 --name budgetzero budgetzero/budgetzero
```
Your budgetzero instance is now running at :
## Manual Deployment
You can also build the static files and host on any webserver.
```
npm install
npm run build
```
The files will be built into the dist/ folder and can be hosted anywhere.
## Sync Server Setup
Budgetzero uses [PouchDB](https://pouchdb.com/) to store the all data client-side in the browser. In order to enable sync across multiple browsers and/or devices, you'll need to set up a [CouchDB](https://couchdb.apache.org/) server accessible from the desired devices. This setup guide is a general overview, feel free to adapt as needed.
Manual Setup Instructions for Advanced Users
1. Install CouchDB on a server: [Manually](https://docs.couchdb.org/en/stable/install/index.html) or with the [official docker couchdb](https://github.com/apache/couchdb-docker) image.
If you're using docker, start CouchDB using the provided instructions.
Example:
```
docker run -d --name budgetzero-couchdb-sync -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password couchdb:latest
```
Replace admin and password with desired user/password.
2. Navigate to http://[docker_host_IP]:5984/_utils, which opens the Fauxton web interface for CouchDB administration.
4. Go to 'Configuration' and enable CORS for all domains.
5. Create a database with whatever name you desire.
6. In BudgetZero, go to Settings and set the couchdb URL to start syncing. This will need to be set up for each client/browser/computer/etc.
Examples:
```http://localhost:5984/mybudget```
```http://username:[email protected]:5984/mybudget```
# Development
## Pull Requests
Good pull requests (patches, improvements, new features) are a greatly appreciated.
Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise, you risk spending a lot of time working on something that might not get accepted or is already in development.
## Dev Setup
```
npm install
```
### To start a development web server:
```
npm run serve
```
### Run tests
Run all tests once:
```
npm run test:unit
```
Run all tests and re-run if files change:
```
npm run test-watch:unit
```
Run with debugger (chrome://inspect)
```
node --inspect node_modules/.bin/jest --runInBand tests/unit/Transactions.spec.js
```