https://github.com/mlesniak/budget-tracker

A full-featured budget and saving tracking application in go
https://github.com/mlesniak/budget-tracker

budgeting finance go

Last synced: 5 months ago
JSON representation

A full-featured budget and saving tracking application in go

• Host: GitHub
• URL: https://github.com/mlesniak/budget-tracker
• Owner: mlesniak
• License: apache-2.0
• Created: 2018-02-27T16:25:53.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-05-27T03:25:42.000Z (about 6 years ago)
• Last Synced: 2024-06-20T13:28:58.960Z (about 2 years ago)
• Topics: budgeting, finance, go
• Language: Go
• Size: 155 KB
• Stars: 30
• Watchers: 4
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/mlesniak/budget-tracker.svg?branch=master)](https://travis-ci.org/mlesniak/budget-tracker)

[![Go Report Card](https://goreportcard.com/badge/github.com/mlesniak/budget-tracker)](https://goreportcard.com/report/github.com/mlesniak/budget-tracker)

# Overview

A simple budget tracker to keep track of your incoming and outgoing expenses per month as well as statistics about your daily available 

money. Besides a web-frontend which is also usable on a mobile device it provides a comfortable REST API for all your command-line magic.

# Status

All features that I need are implemented. Open an issue if you have the need for an additional feature, or

even better, provide a pull request :-).

In the following we show a screenshot of the current mobile user interface with

fake data (i.e. everything is positive, no expenses, ...).

![Screenshot](current-status.png)

# Build

Note that you should clone this repository in your `$GOPATH/src/github.com/mlesniak/budget-tracker`. In addition, you should have installed go-bindata, e.g. using

    go get -u github.com/jteeuwen/go-bindata/...

We use `make` to build, hence a 

    make all

should suffice. To generate docker images for two instances proxied by nginx, use

    make docker

to generate the docker images budget/nginx and budget/core. Adapt default.conf to provide

more instances.

# Technologies

We use

- Backend: Go(lang)

- Frontend: Vuejs + Bootstrap

Note that currently no particular frontend packaging system is used, e.g. nothing like webpack and co.

# Guiding Principles

I will be guided by the following principles

- Open Source everything

- Be open to suggestions

- Write idiomatic go code

- Be pragmatic about testing, but try to test everything

- Do not over-engineer

# HTTPS Support

Since the cookie is (currently) submitted in plaintext, at least a HTTPS connection is mandatory. To

generate the necessary server key, use

    openssl genrsa -out server.key 2048

To generate the corresponding certificate, use

    openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650

## License

The source code is licensed under the [Apache license](https://raw.githubusercontent.com/mlesniak/budget-tracker/master/LICENSE)