deywersonp / FinAPI

FinAPI is a developed API that focuses on registering customers and managing financial operations such as withdrawals, deposits, statements, among others. This application was developed during the first chapter of the NodeJS track from IGNITE (Rocketseat Career Acceleration Program).

FinAPI

Project   |    Technologies   |    Services Used   |    Getting Started   |    How To Use   |    Features   |    License

💻 Project

FinAPI is a developed API that focuses on registering customers and managing financial operations such as withdrawals, deposits, statements, among others.

🚀 Technologies

This project was developed using these techs:

• Node.js
• JavaScript
• Express

👨‍🔧 Services Used

• GitHub

🎮 Getting Started

If you want run this code, you can start cloning the repository using HTTP or SSH key.

• Open your git

• Type git clone

• Insert the HTTP or SSH key (on windows, shift + insert to paste on gitBash)

• You can find this HTTP or SSH Key by clicking on Code on the top right in this repository

• Once cloned you can open the project in your IDE and enter the codes below in the IDE terminal

yarn To add the dependencies on the project.

yarn dev Runs the app in the development mode.
Open http://localhost:3333 to view it in the browser.

You can use Insomnia (or other similar tool) to test the application's routes.

Dependencies

• Express
• uuid

Dev Dependencies

• Nodemon

📌 How to Use

1 - Open the aplication on your IDE

2 - Run yarn dev on your IDE terminal

3 - Use Insomnia to test the application's routes

🕵 Features

The main features of the application are:

• Create an account
• Fetch the customer's bank statement
• Make a deposit
• Make a withdrawal
• Fetch the customer's bank statement by date
• Update customer account data
• Get customer account data
• Delete an account
• Return the balance

Business Rules

• It's not possible to register an account with an existing CPF
• Unable to fetch a non-existing account statement
• It's not possible to make a deposit to a non-existing account
• Unable to withdraw from a non-existing account
• It's not possible to withdraw when the balance is insufficient
• Cannot delete a non-existing account

📝 License

This project is under MIT license.

In case of sensitive bugs like security vulnerabilities, please contact [e-mail] directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!

---

Please follow on github and join us! Thanks for visiting me and good coding!

Made with ♥ by Deywerson Pereira