Giter VIP home page Giter VIP logo

bank_api's Introduction

BANK_API

This project was built as a test for an interview. The goal was to build an Ruby on Rails API with three end-points:

  • create_account: let you create a bank account
  • create_transaction: let you create transactions (credit or debit) for the bank accounts
  • list_transactions: let you list all the transactions that happened in a bank account

Path and parameters to the endpoints:

  • localhost:3000/bank-accounts/create

    name

    cpf

    birthday

    doc_image

  • localhost:3000/transactions/create

    account_number

    amount

    trans_type (credit or debit)

  • localhost:3000/transactions/statement

    account_number

You can also use the sh scripts provided with the parameters in the command line to send the requests. For example:

./create_account Joao 04353814908 18/03/1993 /home/João/avatar.png

The cpf verification is disabled for testing.

Todo:

  • better error messages
  • alter the path of the endpoints if desired by the client

System requirements:

  • Ruby 2.7.2
  • Rails 7.0.3
  • Postgresql
  • active_storage (rails active_storage:install)
  • jsonapi
  • validates_timeliness
  • validators
  • jq (linux) to display beautiful json

bank_api's People

Contributors

jmflach avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.