fin

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 10, 2019 License: MIT Imports: 18 Imported by: 0

README

Fin

Fin is an open source backend API to track personal finances, made with Go. Very alpha.

Documentation at Postman Build Status Coverage Status

Considerations

I used this project to learn Go. Expect some messy code. Maybe some bugs. Definitely bugs.

So far this project has no "hosted version", so you need to deploy by yourself.

Using it

Set the environment variables:

$ export DB=postgres://user:pass@host:port/dbame
$ export DB_TEST=postgres://user:pass@host:port/dbame
$ export PORT=5000

Run it:

$ git clone git@github.com:jonatasbaldin/fin
$ make build
$ make run

With Docker:

$ docker pull jonatsabaldin/fin
$ docker run -e DB="postgres://user:pass@host:port/dbame" -e PORT=5000 -p 5000:5000 jonatasbaldin/fin

Contributing

Building the project and running tests. Requires Go v1.11 or later.

$ git clone git@github.com:jonatasbaldin/fin
$ make test
$ make build

You may want to tackle some issues.

Roadmap

  • Add User profiles
  • Add support for crypto currencies Rates
  • Add logs/telemetry
  • Add fin service to docker-compose.yml

License

MIT.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL