This is a simple financial technology RESTful api
- User can create an account
- Users can fund their account using their bank details
- Users can transfer funds to another user
- Users can add beneficiary (bank to withdraw to)
- Users can withdraw funds to beneficiary
The Api Documentation for this project can be found on api documentation .
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes
You need to have Mysql,Adonis, Nodejs, and Npm installed globally on your local machine
- Clone the repository
https://github.com/Joshua-onwuzu/fintech-api.git - Navigate to the location of the folder and run
npm installto install dependencies - Rename
.env.exampleto.env - Set the .env DB_CONNECTION to mysql
- Set the DB_USER and DB_PASSWORD variables to your mysql username and password
- Create a database in mysql using
CREATE DATABASE exampleand set the DB_DATABASE variable in the .env file to the name of the database - Run
adonis migration:runto save table and column to the database - Run
adonis serve --devto start the server
Use the following bank details to test the fund, withdrawal, and the add beneficiary endpoints