aalug / bank-go Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 6.89 MB

Bank API built in Go and Gin

Makefile 1.75% Go 93.42% Dockerfile 0.89% Shell 3.94%

api go golang postgres rest-api gin

bank-go's Introduction

Go Bank

App built in Go 1.20

The app uses:

Getting started

Clone the repository
Go to the project's root directory
Rename app.env.sample to app.env and replace the values
Run in your terminal:
- docker-compose up --build to run the containers
Now everything should be ready and the server running on SERVER_ADDRESS specified in app.env

Testing

Run the containers (database container is sufficient)
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. Password: bankgopassword

bank-go's People

Contributors

Watchers

bank-go's Issues

Create `create user` API

Create create user API and test it.
It should allow to create new users.

Implement sqlc

Implement sqlc in the project.

Embed swagger docs into Go binary

Embed the swagger docs directory into Go binary to serve from an http.FileSystem.
Use statik.

Add database docs

Add database documentation using dbdocs.io.
Create the .dbml schema of the database and create a webpage with the documentation.

Add CRUD for the transfers table

Add functions for CRUD operations for the transfers table and test them.

Add users table

Add users table and set the accounts owner to reference the users table.

Implement golang-migrate

Implement golang-migrate in the project and add init schema.

Add HTTP gateway

Add HTTP gateway.
Use grpc-gateway.
For now, there will be only two endpoints working with this.
The rest will be implemented later.

Implement JWT authentication

Implement JWT authentication in the project.

Add a transactions store

Add a transactions store that will handle all transfer-related logic. It will create a transaction, two entries, and update accounts balances.
Test it.

Update `TransferTx` function

Update TransferTx function to avoid deadlocks. Add order to updating accounts to avoid deadlocks.
Add another test to test that.

Create login user API

Create login user API and test it.

Add CRUD for the accounts table

Add functions for CRUD operations for the accounts table and test them..

Add middleware to protect routes

Add middleware to protect routes.
Update tests that will fail because of this change.
Add tests to check that only authenticated users can use protected routes.

Extract metadata from context

Extract metadata from context.
The metadata needed right now is:

user agent
client IP
Both of those are required to create a session in the database.