Git Product home page Git Product logo

abhi9720 / bankingportal-api Goto Github PK

View Code? Open in Web Editor NEW
67.0 3.0 50.0 37.51 MB

The banking portal API provides secure and efficient endpoints for managing user accounts, transactions, and fund transfers, offering essential banking functionalities with robust error handling and authentication.

License: MIT License

Java 99.83% Dockerfile 0.17%
spring-boot spring-security spring-security-jwt banking-api banking-applications banking-management banking-system banking-transactions jwt-authentication maven

bankingportal-api's Introduction

Banking Portal Rest API Using Spring Boot & Spring Security

Fork and Star โญ Github Repo For New Feature Update

API Documentation

Banking Portal UI

image

The Banking Portal API provides a set of endpoints for managing user accounts, fund transfers, and transactions. This project aims to facilitate secure and efficient banking operations for users.

Features

  • User Registration: Users can register by providing their details, such as name, email, address, and phone number.
  • PIN Management: Users can create and update their PINs for added security.
  • Cash Deposit and Withdrawal: Users can deposit and withdraw cash from their accounts.
  • Fund Transfer: Users can transfer funds to other accounts within the system.
  • Transaction History: Users can view their transaction history.

Technologies Used

image image image image image image image

TODO

  • UI Fix for Dashboard Charts
  • Pagination in table
  • Save JWT Token in db and remove on logout
  • Email trigger on account login
  • Send Bank Statement on Email

Installation and Setup

  1. Clone the repository: git clone https://github.com/yourusername/banking-portal-api.git
  2. Navigate to the project folder: cd banking-portal-api
  3. Configure MySQL: Set up a MySQL database and update the database credentials in application.properties.
  4. Build and run the project: mvn spring-boot:run

Screenshots

project

Error Handling

The API implements global exception handling for common error scenarios, such as account not found, unauthorized access, and insufficient balance.

How to Contribute

We welcome and encourage developers to contribute to the project and help us make it even better. If you are interested in contributing, follow these steps:

๐Ÿ‘‰๐ŸปFork the Repository: Click on the "Fork" button on the top right corner of the GitHub repository page. This will create a copy of the repository in your GitHub account.

๐Ÿ‘‰๐ŸปClone the Forked Repository: Open your terminal or command prompt and use the following command to clone the repository to your local machine:

git clone https://github.com/your-username/BankingPortal-API.git

Replace your-username with your GitHub username.

๐Ÿ‘‰๐ŸปCreate a New Branch: Move into the project directory using cd BankingPortal-API and create a new branch for your changes:

git checkout -b feature/your-new-feature

Replace your-new-feature with a descriptive name for your contribution.

๐Ÿ‘‰๐ŸปMake Changes: Now, make the desired changes to the codebase using your favorite code editor.

๐Ÿ‘‰๐ŸปCommit Changes: After making the changes, save your work and commit the changes with a meaningful commit message:

git add .
git commit -m "Add your commit message here"

๐Ÿ‘‰๐ŸปPush Changes: Push your changes to your forked repository:

git push origin feature/your-new-feature

๐Ÿ‘‰๐ŸปCreate a Pull Request: Go to your forked repository on GitHub, and you'll see a "Compare & Pull Request" button. Click on it to create a new pull request.

๐Ÿ‘‰๐ŸปWait for Review: Your pull request will be reviewed by the project maintainers. Make any necessary changes based on their feedback.

๐Ÿ‘๐Ÿป๐Ÿ‘๐Ÿป Congratulations! ๐ŸŽ‰๐ŸŽŠ Your contribution has been accepted and merged into the main repository. You are now a contributor to the project.

bankingportal-api's People

Contributors

abhi9720 avatar bakhshimoeez avatar pg312 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

bankingportal-api's Issues

Swagger UI for Documentation is comprehensible for both developers and non-developers like clients or project managers.

Is your feature request related to a problem? Please describe.
For developers and non developers that might take interest in this project might need swagger UI for easy documentation and comprehension

Describe the solution you'd like
Implement swagger UI. I mean the Open API version

Describe alternatives you've considered
Postman is an alternative sure. But it does not make documentation as easy and comprehensible as swagger UI

Additional context
I want to ask if I can go ahead with implementing swagger with the app

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.