Add colors, fix bugs
This commit is contained in:
@@ -19,13 +19,40 @@
|
||||
|
||||
1. About
|
||||
========
|
||||
This is the manual for the financer application - a simple app to manage your personal finances.
|
||||
This is the manual for the financer application - a simple app to support you in managing your personal finances.
|
||||
|
||||
The main goal of the financer application is to keep things simple by not attempting to provide sophisticated
|
||||
automation. Instead it is merely a tool that provides basic key values to support you.
|
||||
|
||||
2. Overview
|
||||
===========
|
||||
|
||||
3. Architectural overview
|
||||
=========================
|
||||
The financer application currently consists of two components - a server and a client. They communicate via a JSON
|
||||
REST API. The only available client is a web client that supports a boiled down view for mobile devices, though.
|
||||
|
||||
Both client (-web-client) and server (-server) reside in dedicated Maven modules, with a common (-common) module
|
||||
that holds common model classes and DTOs. Both components are layered:
|
||||
|
||||
____________ C
|
||||
| Controller | L
|
||||
|------------| I
|
||||
| Chart | E
|
||||
S ____________ |------------| N
|
||||
E | Controller |<-------REST--------| Template | T
|
||||
R |------------| '------------'
|
||||
V | Service |
|
||||
E |------------|
|
||||
R | DBA |
|
||||
'------------'
|
||||
|
|
||||
|
|
||||
,-------,
|
||||
| DB |
|
||||
'-------'
|
||||
|
||||
Each component is contained in a distinct artifact.
|
||||
|
||||
4. Account types
|
||||
================
|
||||
@@ -115,6 +142,24 @@
|
||||
|
||||
6. Account groups
|
||||
=================
|
||||
Account groups are a simple way to group account into topics. Imagine the following accounts:
|
||||
- Rent
|
||||
- Electricity
|
||||
- Water
|
||||
- Groceries
|
||||
- Takeaway
|
||||
- Coffee shop
|
||||
- Cinema
|
||||
- Netflix
|
||||
|
||||
They could be grouped via the following three groups:
|
||||
- Housing for Rent, Electricity and Water
|
||||
- Food for Groceries, Takeaway and Coffee shop
|
||||
- Entertainment for Cinema and Netflix
|
||||
|
||||
This additional hierarchy level is actively used by reports to provide a better picture about where money is spent.
|
||||
The financer application makes no hard guidelines on how to model your accounts and account groups, so you can model
|
||||
them matching your needs.
|
||||
|
||||
7. Transactions
|
||||
===============
|
||||
|
||||
Reference in New Issue
Block a user