Currency Converter

API for converting between BRL, USD, EUR, JPY currencies.

⚒️ Resources

Tools
Consumed API
- Api Layer

🏃‍♂️ Running

Setup

Setup a postgres database url in .env file DATABASE_URL, exemple:

API_KEY=123456990120310912031            # Visit https://apilayer.com and put your API key here
DATABASE_URL="mongodb+srv://<USER>:<PASSWORD>@<HOST>/currencyconverterdb"

OBS: Prisma setup use mongodb provider. So, should be defined a valid mongodb database URL

Run the project: npm run dev
Try to use the currency conversion doc

🍀 Features

Create transactions to convert currencies

  # /api/v1/transactions

  curl -X POST http://localhost:3333/api/v1/transactions \
       -H 'Content-Type: application/json' \
       -d '{ "from": "BRL", "to": "USD", "amount": 5 }'

List registered transactions

  # /api/v1/transactions

  curl -X GET http://localhost:3333/api/v1/transactions \
       -H 'Content-Type: application/json'

✔️ Desired items

[✔️] - Logs [✔️] - Exception handler [✔️] - Documentation [✔️] - Clear commits message [✔️] - Lint config [✔️] - Unit test [✔️] - Integration test [✔️] - Endpoints documentation [❌] - Deploy [❌] - CI/CD

📦 Folder structure

📦 currency-converter
 ┣ 📂 prisma
 ┣ 📂 src
 ┃ ┣ 📂 common-types
 ┃ ┣ 📂 exception
 ┃ ┣ 📂 providers
 ┃ ┃ ┃ ┣ 📂 database
 ┃ ┃ ┃ ┣ 📂 http-client
 ┃ ┃ ┃ ┣ 📂 logger
 ┃ ┣ 📂 v1
 ┃ ┃ ┣ 📂 entities
 ┃ ┃ ┣ 📂 middlewares
 ┃ ┃ ┣ 📂 repositories
 ┃ ┃ ┣ 📂 use-cases
 ┃ ┃ ┃ ┣ 📂 create-transaction
 ┃ ┃ ┃ ┣ 📂 list-transaction
 ┃ ┣ 📜 routes
 ┃ ┣ 📜 index.ts
 ┣ 📜 .gitignore
 ┣ 📜 README.md
 ┣ 📜 LICENSE
 ┣ 📜 package-lock.json
 ┣ 📜 package.json
 ┣ 📜 tsconfig.json

🎯 Tools Motivation

Thinking about a simple project, easy to test and with high capacity to improvements, the API was built using the clean architecture principles. It came up with pros and cons, like tools limitation that could work togheter respecting these principles. Prisma and axios are one of those! Prisma combined the ability to work with repositories without dirt things in our entities and low accoplament, for example. Axios, on the other hand, provided a way to handle with http client to handle with requests.

👦 Developer

_{Henrique Barros}

henriquebarrosx/CoinConverterApi