gobank

module
v0.0.0-...-2877753 Latest Latest
Warning

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

Go to latest
Published: Dec 24, 2022 License: MIT

README

gobank

A SAAS banking application built with Go, and PostgreSQL, To manage your bank account, and make transactions.

LIVE API DOCS

How to run

First, you need to have docker and docker-compose installed on your machine.

First we need to set the env variables, so copy the default env files to .env and .env.db files.

cp .env.example .env
cp .env.db.example .env.db

Then, run the following command:

docker-compose up

Features

The applicatoin uses paseto for authentication.

User
  • Create a user
  • Login
  • Renew access token
  • Upadte user
Account
  • Create an account
  • Get all accounts (Of the logged in user)
  • Delete an account (Soft delete, Can be restored)
  • Restore an account (After has been deleted)
Transaction
  • Create a transaction
  • Get all transactions (Of a specific account)

Tech Stack

  • Gin
  • PostgresSQL
  • gomock

GRPC Services

The project uses GRPC besides the REST API, to communicate with db. But the GRPC are not implemented yet fully as the API.

Directories

Path Synopsis
api
cmd
docs
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
db
mock
Package mockdb is a generated GoMock package.
Package mockdb is a generated GoMock package.
cmd
gateway
cmd
grpc
pb
Package pb is a reverse proxy.
Package pb is a reverse proxy.

Jump to

Keyboard shortcuts

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