Skip to content

Commit f917482

Browse files
TheAxelanderTheAxelander
committed
Merge branch 'develop' into 'master'
Update README and LICENSE See merge request Axelander/openbudgeteer!1
2 parents 2b1c6fb + 5de964f commit f917482

File tree

4 files changed

+182
-40
lines changed

4 files changed

+182
-40
lines changed

‎CHANGELOG.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11
### 0.12 (2020-08-04)
22

3-
* [Add] Current version number and database name to header #43
4-
* [Add] Bucket Notes #51
3+
* [Add] Current version number and database name to header
4+
* [Add] Bucket Notes
55
* [Add] Footer for App Icon references
66
* [Changed] Redesign Page Layout moving Navigation into Header
7-
* [Changed] Proper Home Page with links to Gitlab #40
7+
* [Changed] Proper Home Page with links to Gitlab
88
* [Changed] Redesign Account Page
9-
* [Changed] Redesign Balance details on Bucket Page #50
9+
* [Changed] Redesign Balance details on Bucket Page
1010
* [Changed] Removed Page Titles
1111
* [Changed] Changed ConnectionString setup for Docker (Splitted full ConnectionString into several pieces for User, Password etc.)
1212
* [Changed] Removed Blazor in Assembly name (now ```OpenBudgeteer.dll```)
1313
* [Changed] HTML Title from ```OpenBudgeteer.Blazor``` to ```OpenBudgeteer```
14-
* [Fixed] Database update on Number and Date format for Import Profile #47
15-
* [Fixed] Total Pending Want update after Bucket Creation and Deletion #52
14+
* [Fixed] Database update on Number and Date format for Import Profile
15+
* [Fixed] Total Pending Want update after Bucket Creation and Deletion
1616
* [Fixed] YearMonthSelector styles and alignment on Bucket Page
1717
* [Fixed] Database Issue during Bucket Deletion
1818
* [Fixed] IsInactiveFrom value for newly created Buckets
1919

2020
### 0.11.1 (2020-07-18)
2121

22-
* [Fixed] Broken responsive design for Monthly Bucket Expenses #42
22+
* [Fixed] Broken responsive design for Monthly Bucket Expenses
2323

2424
### 0.11 (2020-07-18)
2525

26-
* [Add] Page with several Reports #1
27-
* [Add] Popup with Transactions assigned to an Account on Account Page #38
28-
* [Add] Progress Bar for several Bucket Types #20
29-
* [Changed] Deleting a Transaction must be confirmed now #17
30-
* [Changed] Proper Menu Icons on Navigation Menu #33
31-
* [Changed] Replaced Buttons with proper Menu Icons on several places #39
32-
* [Changed] Some 0 values are now hidden on Bucket Page #41
26+
* [Add] Page with several Reports
27+
* [Add] Popup with Transactions assigned to an Account on Account Page
28+
* [Add] Progress Bar for several Bucket Types
29+
* [Changed] Deleting a Transaction must be confirmed now
30+
* [Changed] Proper Menu Icons on Navigation Menu
31+
* [Changed] Replaced Buttons with proper Menu Icons on several places
32+
* [Changed] Some 0 values are now hidden on Bucket Page
3333
* [Changed] App Name on Navigation Menu
3434
* [Changed] Redesigned File Upload on Import Page
3535
* [Changed] Adapted size of UI elements on Account Page
@@ -40,44 +40,44 @@
4040

4141
### 0.10 (2020-07-12)
4242

43-
* [Add] Preview of final records during data import #23
44-
* [Add] Options for Date and Number format for data import #8
45-
* [Add] Header on Bucket Page includes further information like pending Want and negative Balances #35
46-
* [Add] Popup with Transactions assigned to a Bucket on Bucket Page #19
47-
* [Add] Message box to confirm successful data import #22
48-
* [Add] Several Error Message Boxes and proper Error handling #2
49-
* [Changed] Only display modification buttons on mouse hover #16
50-
* [Fixed] Inconsistent number output format for 0 on Bucket Page #29
51-
* [Fixed] Multiple Budget distribution on Buckets #28
43+
* [Add] Preview of final records during data import
44+
* [Add] Options for Date and Number format for data import
45+
* [Add] Header on Bucket Page includes further information like pending Want and negative Balances
46+
* [Add] Popup with Transactions assigned to a Bucket on Bucket Page
47+
* [Add] Message box to confirm successful data import
48+
* [Add] Several Error Message Boxes and proper Error handling
49+
* [Changed] Only display modification buttons on mouse hover
50+
* [Fixed] Inconsistent number output format for 0 on Bucket Page
51+
* [Fixed] Multiple Budget distribution on Buckets
5252

5353
### 0.9 (2020-07-07)
5454

55-
* [Add] Added selection of Delimiter and Text qualifier during data import #8
56-
* [Add] Button to edit and save all Transaction #30
57-
* [Add] Bucket Page shows an information at which YearMonth a Bucket will be inactive #31
58-
* [Changed] Creating a new Bucket uses now current YearMonth as initial "First Target Date" #25
55+
* [Add] Added selection of Delimiter and Text qualifier during data import
56+
* [Add] Button to edit and save all Transaction
57+
* [Add] Bucket Page shows an information at which YearMonth a Bucket will be inactive
58+
* [Changed] Creating a new Bucket uses now current YearMonth as initial "First Target Date"
5959
* [Changed] Creating a new Transaction uses now current YearMonth as initial Transaction Date
60-
* [Changed] A Bucket can only be closed if Balance is 0 #32
61-
* [Fixed] Missing Bucket colors for Crate new Transaction #27
62-
* [Fixed] Only active Buckets for current YearMonth are displayed for Bucket assignment on Transaction Page #26
60+
* [Changed] A Bucket can only be closed if Balance is 0
61+
* [Fixed] Missing Bucket colors for Crate new Transaction
62+
* [Fixed] Only active Buckets for current YearMonth are displayed for Bucket assignment on Transaction Page
6363

6464
### 0.8 (2020-07-01)
6565

66-
* [Add] Colors for Buckets #14
67-
* [Add] Button to distribute Budget on Buckets with Want #11
68-
* [Changed] Input fields for numbers and dates are now properly handled #15
69-
* [Fixed] Want calculation for Bucket Type "Monthly expense" #13
66+
* [Add] Colors for Buckets
67+
* [Add] Button to distribute Budget on Buckets with Want
68+
* [Changed] Input fields for numbers and dates are now properly handled
69+
* [Fixed] Want calculation for Bucket Type "Monthly expense"
7070

7171
### 0.7 (2020-06-30)
7272

73-
* [Fixed] Pressing Enter for InOut updates UI again #12
74-
* [Fixed] Creating a new Bucket properly updates UI again #9
75-
* [Fixed] Fixed Want calculation due to DateTime issues in Data Model #10
73+
* [Fixed] Pressing Enter for InOut updates UI again
74+
* [Fixed] Creating a new Bucket properly updates UI again
75+
* [Fixed] Fixed Want calculation due to DateTime issues in Data Model
7676

7777
### 0.6 (2020-06-29)
7878

7979
* [Add] Added base implementation for Global Balance details
80-
* [Changed] Optimized Performance for Bucket and Transaction Page #4
80+
* [Changed] Optimized Performance for Bucket and Transaction Page
8181
* [Changed] Allow Update of imported Transactions with pending Bucket assignments
8282
* [Fixed] Fixed and optimized Bucket assignment check for Transactions
8383

@@ -101,7 +101,7 @@
101101

102102
### 0.2 (2020-05-18)
103103

104-
* [Add] Enbale creation/update/deletion of Import Profiles #5
104+
* [Add] Enbale creation/update/deletion of Import Profiles
105105

106106
### 0.1 (2020-04-20)
107107

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Alexander Preibisch
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎LICENSE-3RD-PARTY

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
-----------------------------------------------------------------------------
2+
The MIT License (MIT)
3+
applies to:
4+
- BlazorFileReader, Copyright (c) 2018 Tor
5+
- ChartJs.Blazor, Copyright (c) 2019 Marius Muntean
6+
- Pomelo.EntityFrameworkCore.MySql, Copyright (c) 2017 Pomelo Foundation
7+
- TinyCsvParser, Copyright (c) Philipp Wagner
8+
- .NET Core, Copyright (c) .NET Foundation and Contributors
9+
-----------------------------------------------------------------------------
10+
11+
Permission is hereby granted, free of charge, to any person obtaining a copy
12+
of this software and associated documentation files (the "Software"), to deal
13+
in the Software without restriction, including without limitation the rights
14+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15+
copies of the Software, and to permit persons to whom the Software is
16+
furnished to do so, subject to the following conditions:
17+
18+
The above copyright notice and this permission notice shall be included in all
19+
copies or substantial portions of the Software.
20+
21+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27+
SOFTWARE.
28+
29+
-----------------------------------------------------------------------------
30+
Apache License
31+
Version 2.0, January 2004
32+
applies to:
33+
- Microsoft.EntityFrameworkCore, Copyright Microsoft Corporation
34+
-----------------------------------------------------------------------------
35+
36+
Licensed under the Apache License, Version 2.0 (the "License");
37+
you may not use this file except in compliance with the License.
38+
You may obtain a copy of the License at
39+
40+
http://www.apache.org/licenses/LICENSE-2.0
41+
42+
Unless required by applicable law or agreed to in writing, software
43+
distributed under the License is distributed on an "AS IS" BASIS,
44+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
45+
See the License for the specific language governing permissions and
46+
limitations under the License.

‎README.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,78 @@
11
# OpenBudgeteer
22

3-
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
3+
OpenBudgeteer is a budgeting app based on the Bucket Budgeting Principle and inspired by [YNAB](https://www.youneedabudget.com) and [Buckets](https://www.budgetwithbuckets.com). The Core is based on .NET Core and the MVVM Pattern, the Front End uses Blazor Server.
4+
5+
## Installation (Docker)
6+
7+
You can use the pre-built Docker Image from [Docker Hub](https://hub.docker.com/r/axelander/openbudgeteer). It requires a connection to a MySQL database which can be achieved by passing the following variables:
8+
9+
| Variable | Description | Example |
10+
| --- | --- | --- |
11+
| Connection:Server | IP Address to MySQL Server | 192.168.178.100 |
12+
| Connection:Port| Port to MySQL Server | 3306 |
13+
| Connection:Database | Database name | MyOpenBudgeteerDb |
14+
| Connection:User | Database user | MyOpenBudgeteerUser |
15+
| Connection:Password | Database password | MyOpenBudgeteerPassword |
16+
17+
```
18+
docker run -d --name='openbudgeteer'
19+
-e 'Connection:Server'='192.168.178.100'
20+
-e 'Connection:Port'='3306'
21+
-e 'Connection:Database'='MyOpenBudgeteerDb'
22+
-e 'Connection:User'='MyOpenBudgeteerUser'
23+
-e 'Connection:Password'='MyOpenBudgeteerPassword'
24+
-p '6100:80/tcp'
25+
'axelander/openbudgeteer:latest'
26+
```
27+
28+
If you don't change the Port Mapping you can access the App with Port `80`. Otherwise like above example it can be accessed with Port `6100`
29+
30+
### Pre-release Version (Docker)
31+
32+
A Pre-Release version can be used with the Tag `pre-release`
33+
34+
```
35+
docker run -d --name='openbudgeteer'
36+
-e 'Connection:Server'='192.168.178.100'
37+
-e 'Connection:Port'='3306'
38+
-e 'Connection:Database'='MyOpenBudgeteerDb'
39+
-e 'Connection:User'='MyOpenBudgeteerUser'
40+
-e 'Connection:Password'='MyOpenBudgeteerPassword'
41+
-p '6100:80/tcp'
42+
'axelander/openbudgeteer:pre-release'
43+
```
44+
45+
## How to use
46+
47+
### Create Bank Account
48+
49+
The best way to start with OpenBudgeteer is to create at least on Bank Account on the `Account Page`.
50+
51+
### Import Transactions
52+
53+
After that export some Transactions from your Online Banking and import the data using `Import Page`. At the moment it support CSV files only but you can individually set the characters for delimiter and text qualifier. The respective settings and other options are shown once the CSV file has been uploaded.
54+
You also need to create an initial Transaction which includes the Bank Balance on a certain date. It should be the previous day of the very first imported Transaction. You can do this on the `Transaction Page`.
55+
56+
Example:
57+
58+
You have imported all Transactions starting 2020-01-01. To have the right Balances create a Transaction for 2019-12-31 and add as amount the Account Balance of this day. You can mark this Transaction as `Income` (see more explanation in section `Bucket Assignment`).
59+
60+
### Create Buckets
61+
62+
Once you have some Transactions imported you can start creating Buckets on the `Bucket Page`. If you don't know what kind of Buckets you need, maybe start with some Buckets for your monthly or even yearly expenses like Car Insurance, Property Taxes, Instalments etc. and Buckets for your regular needs like Groceries or Gas. You can also create a Bucket for your next big trip by putting some money into it every month.
63+
64+
If you are happy with your setup, put some money into your Buckets. You can do it manually or automatically if a Bucket has a Want for the current month.
65+
66+
### Bucket Assignment
67+
68+
In the final step you assign your Transactions to certain Buckets. Go back to the `Transaction Page`, edit a Transaction and select an appropiate Bucket. You can also do a mass edit. If a Transaction belongs to more than one Bucket just reduce the assigned amount and you get automatically the option to assign the remaining amount to anthoer Bucket.
69+
70+
Transactions which represent your (monthly) income can be assigned to the pre-defined `Income` Bucket. If you have transffered money from one Account to another you can use the `Transfer` Bucket. Please ensure that all `Transfer` Transaction have in total a 0 Balance to prevent data inconsistency and wrong calculations.
71+
72+
Once all Transactions are assigned properly you can go back to the Bucket Overview to see if your Budget management is still fine or if you need to do some movements. You should always ensure that your Buckets don't have a negative Balance. Also your `Remaining Budget` should never be negative.
73+
74+
### Bucket Histroy
75+
76+
OpenBudgeteer has a built-in versioning for Buckets which enables a proper histroy view on previous months. If you modify a Bucket, like changing the Type or the Target Amount, it will create a new version for the current selected month. It is not recommended to change a Bucket in the past, a change between two Bucket Version is prevented.
77+
78+
If you close a Bucket it will be marked as `Inactive` for the next month. This can be only done if the Bucket Balance is 0 to prevent wrong calculations.

0 commit comments

Comments
 (0)