Production Ready Reference for Go

Project given by WEX as code challenge, a API that stores transaction and allows users to retrieve those transactions converting the value of the trasaction to the speciefied country's currency

• WEX
  • Language
  • Used libraries
  • How to run
  • Routes

Language

This project is written in Golang 1.21

Used libraries

Gin

Gin is our HTTP Server, it handles our routing system and HTTP requests

Gorm

ORM library for dealing with database connections

Validator

Helps in validating our entities and dtos

Zap

Leveled loggin library

Testify

Testing tools

How to run

The project can run through Docker or locally first will need to

1. Download and install Go and/or Docker

2. Download this repository

    git clone https://github.com/jvfrodrigues/transaction-product-wex

3. Create .env file copying .env.example

   cp .env.example .env

Using Docker

4. Run docker compose

    docker-compose -f docker-compose-prod.yaml up -d

5. Test! It should run on localhost:8080

6. If you want you can set the env variable in .env to "prd" so it will use postgres instead of sqlite

Locally

4. Install all dependencies

   go mod download

5. Run the project

   go run main.go

6. Test! It should run on localhost:8080

Routes

All available routes are on the insomnia file in the repository.

Here is a list of the routes:

• Healtcheck on GET /health

• Create transaction on POST /transaction the body should be:

  "description": "string",
  "transaction_date": "ISO8601 string date",
  "amount": "number"

• Find transaction and convert to currency on GET /transaction/exchange/{id_to_find}?country={country_to_convert}