https://github.com/aalug/bank-go

Bank API built in Go and Gin
https://github.com/aalug/bank-go

api gin go golang postgres rest-api

Last synced: 2 months ago
JSON representation

Bank API built in Go and Gin

• Host: GitHub
• URL: https://github.com/aalug/bank-go
• Owner: aalug
• Created: 2023-06-01T15:42:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-03T18:51:58.000Z (over 1 year ago)
• Last Synced: 2024-09-30T07:21:33.485Z (3 months ago)
• Topics: api, gin, go, golang, postgres, rest-api
• Language: Go
• Homepage:
• Size: 6.73 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Go Bank

### App built in Go 1.20

## The app uses:

- Postgres

- Docker

- [Gin](https://github.com/gin-gonic/gin)

- [golang-migrate](https://github.com/golang-migrate/migrate)

- [sqlc](https://github.com/kyleconroy/sqlc)

- [testify](https://github.com/stretchr/testify)

- [PASETO Security Tokens](github.com/o1egl/paseto)

- [jwt-go](https://github.com/dgrijalva/jwt-go)

## Getting started

1. Clone the repository

2. Go to the project's root directory

3. Rename `app.env.sample` to `app.env` and replace the values

4. Run in your terminal:

    - `docker-compose up --build` to run the containers

5. Now everything should be ready and the server running on `SERVER_ADDRESS` specified in app.env

## Testing

1. Run the containers (database container is sufficient)

2. Run in your terminal:

    - `make test`

   or

    - `make test_coverage p={PATH}` - to get the coverage in the HTML format - where `{PATH}` is the path to the target directory for which you want to generate test coverage. The `{PATH}` should be replaced with the actual path you want to use. For example `./api`

   or

    - simply use `go test` commands

## API Endpoints

#### Users (only endpoints that do not require authentication)

 - `/users` - handles POST requests to create users

 - `/users/login` - handles POST requests to log in users

 - `/tokens/renew` - handles  POST requests to renew the access tokens

### Accounts

- `/accounts` - handles POST requests to create accounts

- `/accounts` - handles GET requests to get all accounts

- `/accounts/{id}` - handles GET requests to get account details

- `/accounts/{id}` - handles DELETE requests to delete an account

### Transfers

- `/transfers` - handles POST requests to transfer money from one account to another

## Documentation

### API

After running the server, the API (HTTP gateway) documentation 

can be found at http://localhost:8080/docs/

### Database

The database's schema and intricate details can be found on 

dedicated webpage, which provides a comprehensive overview 

of the data structure, tables, relationships, and other essential 

information. To explore the database further, please visit

this [dbdocs.io webpage](https://dbdocs.io/aalug/bank_go).

Password: `bankgopassword`