Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.84 KB

README.md

File metadata and controls

48 lines (31 loc) · 1.84 KB

Budjit

GitHub issues Build status

This is a .NET core web application, integrated with Electron.NET to provide a cross platform desktop finance budgeting solution.


Features

  • Importing from Santander bank exports
  • Grouping individual transactions

Setup

Requirements

Clone this repo to your machine and run dotnet build to install and compile project dependencies.

Run dotnet restore src/budjit.ui to install UI related dependencies including the dotnet cli electron tool, Electron.Net


Usage

Web app

Navigate to src/budjit.ui/ and run dotnet run. You will then be able to access it at localhost:5000

Electron desktop app

Note: If you are running this on Linux/Mac, you will need to run this command first sudo npm install electron-packager --global

Navigate to src/budjit.ui/ and run dotnet electronize start. This will publish and execute the application using the Electron.Net ui.

Under src/budjit.core.runner/Examples/CSV there are sample .csv files you can use for importing.


Publishing

Navigate to src/budjit.ui and run dotnet electronize build. The end result should be an electron app under your /bin/desktop folder.


License

You can check out the full license here

This project is licensed under the terms of the GNU General Public License v3.0 license.