https://github.com/diegoclair/bank-transfer

https://github.com/diegoclair/bank-transfer

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/diegoclair/bank-transfer
• Owner: diegoclair
• Created: 2021-08-21T18:19:50.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-08-29T23:17:59.000Z (over 3 years ago)
• Last Synced: 2024-11-14T13:54:23.372Z (2 months ago)
• Language: Go
• Size: 99.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## 📝 Project

Bank Transer API

  

### Description :airplane:

The goal of this API is to simulate a bank.   

So you can create an account, do login and start to do transfers for other accounts.  

You can also see all transfers that you did and received.  

  

The API has some endpoints that you can use to see all accounts, an specified account, a balance of an account.

## ▶️ Start application 💻 

### ❗ First of all:

* You need to have docker installed in your computer.

### Start ▶️

To start the applciation, you need just to run the command `docker-compose up`. When you see this message `your server stated on [::]:5000` so your app is running correctly!

### 📝 Docs:

Inside of the `/docs` folder, you can see the Swagger documentation of the API Endpoints and a postman collection with this endpoints.

### Observations

- When you create an account, this account already start with 200 as balance, just to help to test the application.

## 💻 Tech  infos

- The architecture of files and folders was based on (DDD) domain driven design.

- We could add more tests as the project evolves to avoid errors.

   

:bowtie: