https://github.com/stevenferrer/kalupi
A wallet service built with go-kit
https://github.com/stevenferrer/kalupi
double-entry double-entry-accounting go go-kit golang postgresql wallet wallet-service
Last synced: about 2 months ago
JSON representation
A wallet service built with go-kit
- Host: GitHub
- URL: https://github.com/stevenferrer/kalupi
- Owner: stevenferrer
- License: mit
- Created: 2021-06-07T20:23:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-04T02:33:04.000Z (over 3 years ago)
- Last Synced: 2025-03-24T03:23:22.632Z (2 months ago)
- Topics: double-entry, double-entry-accounting, go, go-kit, golang, postgresql, wallet, wallet-service
- Language: Go
- Homepage:
- Size: 117 KB
- Stars: 7
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pkg.go.dev/github.com/stevenferrer/kalupi)
[](https://coveralls.io/github/stevenferrer/kalupi?branch=main)
[](https://goreportcard.com/report/github.com/stevenferrer/kalupi)
# Kalupi
Kalupi, a wallet service built with [go-kit](https://github.com/go-kit/kit).
## Features
- [Double-entry accounting](https://en.wikipedia.org/wiki/Double-entry_bookkeeping)
- Modular and extensible design
- Built with [go-kit](https://github.com/go-kit/kit)!
## Limitations
- Only payments within the same currency is supported
- Only USD is supported, other currencies can be supported with relative ease
## Documentation
The REST API documentation is located at [docs/api.md](/docs/api.md).
## Build
Build the server:
```sh
$ go build -v -ldflags "-w -s" -o ./cmd/kalupi ./cmd/kalupi
```
Run the server:
```sh
$ DSN= ./cmd/kalupi
```
## Docker
The container image is hosted on [docker hub](https://hub.docker.com/r/stevenferrer/kalupi).
Run using docker:
```sh
$ docker run -p 8000:8000 \
-e DSN= \
stevenferrer/kalupi:0.1.0-rc1
```
## Development
Requirements:
- [Go](https://golang.org/)
- [Postgres](http://postgresql.org/)
Clone the repository:
```sh
$ git clone [email protected]:sf9v/kalupi.git
```
Setup test database:
```sh
$ docker run --name kalupi-test-db \
-d --rm -p 5432:5432 \
-e POSTGRES_PASSWORD=postgres \
postgres:12
```
Run the tests:
```sh
$ go test -v -cover -race ./...
```
## Shoulders of the giants
The double-entry accounting implementation in this project is heavily based on the [ideas](https://stackoverflow.com/questions/59432964/relational-data-model-for-double-entry-accounting) of [PerformanceDBA](https://stackoverflow.com/users/484814/performancedba) and deserves most of the credit.
## Contributing
All contributions are welcome! Please feel free to [open an issue](https://github.com/stevenferrer/kalupi/issues/new) or [make a pull request](https://github.com/stevenferrer/kalupi/pulls).
## License
[MIT](LICENSE)