JBudgetBook

Überblicke & analysiere deine Ausgaben

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
   • Debug
   • Bauen
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Dieses Haushaltsbuch soll Ihnen einen Überblick über Ihre Ausgaben ermöglichen. Zwei Ansichten sind aktuell implementiert: Monatsansicht und Jahresansicht. Zusätzlich sind Ansichten zur Verwaltung der Ausgaben umgesetzt.

Das Projekt befindet sich noch in einem frühen Stadium, weswegen Bugs auftreten können. Sollten Sie Bugs finden, können Sie dazu gerne Issues anlegen.

(back to top)

Built With

(back to top)

Getting Started

Das Projekt kann lokal wie folgt aufgesetzt werden. Eine Installation als .exe (Windows) oder .app (Mac) ist aktuell nicht möglich.

Installation

1. Repo klonen

   git clone https://github.com/tpoerschke/BudgetBook

2. Starten

   VS Code: mvn clean javafx:run

   IntelliJ: Run Configuration Launch

3. Viel Spaß! :)

Debug

1. Debug-Server starten

   VS Code:mvn clean javafx:run@debug

   IntelliJ:Run Configuration Launch

2. Per Visual Studio Code attachen (.vscode/launch.json)

Bauen

Mithilfe des Shell-Skripts build_app.sh kann die Applikation für das vorliegende Betriebssystem gebaut werden. Untestützt werden MacOS und Linux.

(back to top)

Usage

WIP

(back to top)

Roadmap

• Ausgabenübersicht
• Jahresübersicht
• Kategorien für Ausgaben
• Einzigartige Ausgaben
• Einnahmen verwalten
• Import von Umsätzen
• Budgets
• Analyseübersicht
• (Exportfunktionalität)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.

(back to top)

Contact

Tim Poerschke - post@timkodiert.de

Project Link: https://github.com/tpoerschke/BudgetBook

(back to top)