/FinApi

Primary LanguageJavaScriptMIT LicenseMIT

FinApi

FinApi - An financial aplication.


Index

About

This project is a simple financial API and was developed during Ignite course 👨🏽‍🚀 by RocketSeat 🚀💺💜.

Project Requirements

  • It must be possible to create an account.
  • It must be possible to search for the customer's bank statement.
  • It must be possible to make a deposit.
  • It must be possible to withdraw.
  • It must be possible find a costumer bank statement by date.
  • It must be possible to update costumer account data.
  • It must be possible obtain costumer account data.
  • It must be possible delete a account.
  • It must be possible obtain a customer balance.

Business Rules

  • It should not be possible to register an account with an existing CPF.
  • It should not be possible to deposit for a nonexistent account
  • It should not be possible to obtain a bank statement for a nonexistent account.
  • It should not be possible to withdraw on a nonexistent account.
  • It should not be possible to delete a nonexistent account.
  • It should not be possible to withdraw when account balance is insufficient.

Instalation Requirements

To run this project, please install this:

Installation

Clone the repo.

# Clone this repository
$ git clone https://github.com/FelipePardim/FinApi

Follow the guides bellow to run each project as you like.

How to use

🖥️ Running backend (server). 

# Access back-end folder.
$ cd backend

# Install dependencies.
$ yarn install
#or.
$ npm install

# Start the API server.
$ yarn dev
#or.
$ npm dev

# The back-end server will listen on port 3000.
# Make API calls on http://localhost:3000.

🛠 Technologies

This are the tech stack and tools utilized to develop this project:

📝 License

This project is under LICENSE licensce.

👨🏽‍💻 Author: