jennifertakagi/my-bank-api-node

Control bank accounts with this simple API!

My Bank API

Control bank accounts with this simple API!
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

A simple API to control the bank account.

Features:

• Make a deposit, by agency and account.
• Make withdrawal, by agency and account.
• Make transfer between accounts, by agency and accounts.
• Transfer the biggest clients of each agency to 99 agency.
• Get the balance, by account and agency.
• Get the mean balance, by agency.
• Get the smallest client, by balance and set a limit.
• Get the biggest client, by balance and set a limit.
• Delete a account, by the grade's id.

Built With

• Node JS
• Express
• MondoDB
• Mongoose
• Winston
• Swagger UI Express

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/jennifertakagi/my-bank-api-node.git

2. Install packages

   yarn | npm install

3. Run the following command in order to start the application in a development environment:

   yarn dev:watch | npm run dev:watch

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jennifer Takagi - @jennitakagi

Acknowledgements

• Cors