cardoso010 / api_banking

Stone "Api Banking" Interview Challenge

ApiBanking

Requirements

Resources that must be installed for this project to work.

• docker
• docker-compose

Setup

Clone this repository:

git clone https://github.com/cardoso010/api_banking.git

cd api_banking

This project uses docker-compose.

First of all you need to build the container

docker-compose build

Now is necessary that you run setup to get dependencies, create database, create migrations and run seed.

docker-compose run web mix setup

Then you up your container

docker-compose up

Now you can visit localhost:4000/api/v1 from your browser

Exec tests

docker-compose run -e "MIX_ENV=test" web mix test

Exec coveralls

docker-compose run -e "MIX_ENV=test" web mix coveralls

Generate Swagger Docs

docker-compose run web mix phx.swagger.generate

You can visit Swagger localhost:4000/api/swagger/index.html from your browser.

Deployment

Project is running at Heroku Platform, so you can access https://apibanking.herokuapp.com/api/v1.

Or you can access swagger directly https://apibanking.herokuapp.com/api/swagger/index.html from your browser