https://github.com/hyperjumptech/bookkeeping
Bookkeeping implements the acccore double entry bookkeeping library to be used as a wallet or loyalty applications where proper accouting is important.
https://github.com/hyperjumptech/bookkeeping
Last synced: 7 months ago
JSON representation
Bookkeeping implements the acccore double entry bookkeeping library to be used as a wallet or loyalty applications where proper accouting is important.
- Host: GitHub
- URL: https://github.com/hyperjumptech/bookkeeping
- Owner: hyperjumptech
- License: other
- Created: 2021-08-31T03:54:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T05:47:45.000Z (over 1 year ago)
- Last Synced: 2025-01-20T06:33:02.022Z (over 1 year ago)
- Language: HTML
- Homepage:
- Size: 8.42 MB
- Stars: 4
- Watchers: 5
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Hyperjump Bookkeeping
Bookkeeping is a generic double entry book keeping and journaling management service. It implements the [acccore](https://github.com/hyperjumptech/acccore) accounting library. The service is intended for any applications where double-entry bookkeeping is required, such as wallets and loyalty programs.
## building
This project is built on golang. You need golang installed on your system to run. Minimal version is **1.22** since this project uses `go mod` and resource `embedding`.
You can click here for the [golang resource](https://golang.org) and for more information on go and installations.
To build you can type:
`go build ./...`
## testing
`go test ./... -v -covermode=count -coverprofile=coverage.out`
or
`make test`
`make test-coverage`
## binary generation
`go build -a -o bookkeeping-go-img cmd/Main.go`
or
`make build`
## docker generation
`make docker`
## running docker
`make docker-run`
## api docs
Open API specifications can be seen by hitting the `/docs` endpoint of the running instance.
The file swagger.json can be found in `/static/api/spec`
## Admin Dashboard
Dashboard can be accessed through `/dashboard` endpoint in the running instance.
User need to know the `SecretKey` used to generate the HMAC API Key.
## File structure
├── build
│ ├── azure
│ ├── github
│ └── docker
├── cmd
├── errors
├── internal
│ ├── accounting
│ ├── config
│ ├── connector
│ ├── contextkeys
│ ├── health
│ ├── helpers
│ ├── logger
│ ├── middlewares
│ └── router
├── migrations
├── static
│ ├── api
│ ├── dashboard
│ └── mime
## Further information see
1. [Golang Project Structure](https://tutorialedge.net/golang/go-project-structure-best-practices)
2. [Golang standard project layout](https://github.com/golang-standards/project-layout)