https://github.com/lordvidex/gomoney

💰 Funds management made easy. Includes a telegrambot and a REST API with all modules connected together with gRPC
https://github.com/lordvidex/gomoney

grpc-go money-manager rest-api telegram-bot

Last synced: 3 months ago
JSON representation

💰 Funds management made easy. Includes a telegrambot and a REST API with all modules connected together with gRPC

• Host: GitHub
• URL: https://github.com/lordvidex/gomoney
• Owner: lordvidex
• License: mit
• Created: 2022-11-30T21:15:49.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-14T11:42:58.000Z (almost 3 years ago)
• Last Synced: 2024-04-18T15:57:22.234Z (almost 2 years ago)
• Topics: grpc-go, money-manager, rest-api, telegram-bot
• Language: Go
• Homepage:
• Size: 206 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# GoMoney 

[![GoDoc](https://godoc.org/github.com/lordvidex/gomoney?status.svg)](https://godoc.org/github.com/lordvidex/gomoney)

[![Go Report Card](https://goreportcard.com/badge/github.com/lordvidex/gomoney)](https://goreportcard.com/report/github.com/lordvidex/gomoney)

[![Coverage Status](https://coveralls.io/repos/github/lordvidex/gomoney/badge.svg?branch=main)](https://coveralls.io/github/lordvidex/gomoney?branch=main)

## About GoMoney

GoMoney is a project that aims to provide an intuitive

 and easy to use solution for managing funds and accounts.

 

 Users can create multiple accounts and log fund transfers between these accounts. It is also possible to access accounts from various platforms

## Contents

![schema](./schema.drawio.svg)

The GoMoney library contains the following subpackages:

- Telegram server

- REST API server 

- Data server

### Telegram server [/telegram](/telegram)

The telegram server is a simple telegram bot that allows users to interact with the GoMoney API. It is written in Go and uses the [telego library](https://github.com/SakoDroid/telego).

### REST API server [/api](/api)

REST API server makes the GoMoney service accessible to other application via a REST API. 

### Data server [/server](/server)

Data server is responsible for handling all the interactions with the database.

## Build project 

To build the docker image first set the env vars or use the default values by using the following command

```bash

cp .env.example .env

cp .db.env.example .db.env

```

Then build the docker image using the following command

```bash

docker-compose up

```

## RoadMap

- [x] Build basic structure around hexagonal architecture

- [x] Complete Account implementation on grpc server

- [x] Complete telegram bot with functions

- [x] Complete REST API

- [x] Host the application