dalgriff / credit-card-api

Credit Card API

The Credit Card API is a Spring Boot application designed to provide RESTful endpoints related to credit card operations. Originally built using JDBC, this project serves as a teaching aid to demonstrate the process of refactoring and upgrading a Spring Boot application.

Table of Contents

• Current Functionality
• Proposed Refactor
• Getting Started
• Contributing
• License

Current Functionality

The current version of the Credit Card API offers the following features:

1. Credit Card CRUD Operations: Create, Read, Update, and Delete operations for credit card data.
2. Validation: Ensures that credit card numbers are valid using the Luhn algorithm.
3. Outdated Libraries: The project uses older versions of several libraries and Spring Boot.

Proposed Refactor

The upcoming refactoring process aims to modernize the application and introduce best practices. The roadmap includes:

1. Library Upgrades: Update all outdated libraries to their latest stable versions.
2. JDBC to JPA Transition: Migrate the data access layer from JDBC to JPA, leveraging the power of ORM and reducing boilerplate code.
3. Security Enhancements: Introduce security measures to protect the API endpoints.
4. Deployment Configurations: Set up configurations to streamline the deployment process.
5. Docker Integration: In the future, the project will be containerized using Docker for easier deployment and scalability.

Getting Started

To set up the project locally:

1. Clone the Repository:

   git clone https://github.com/dalgriff/credit-card-api.git

2. Navigate to the Project Directory:

   cd credit-card-api

3. Install Dependencies (assuming Maven is used):

   mvn install

4. Run the Application:

   mvn spring-boot:run

Contributing

We welcome contributions! Please follow the Git workflow mentioned above. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

This README provides a clear understanding of the project's current state and its future direction. As the project evolves, the README can be updated to reflect new changes, features, and improvements.

---

© 2023 appGnos. All rights reserved.

credit-card-api's Issues

Set up the Development Environment

Ensure all tools, IDEs, and necessary software are installed and configured for the project.

Branch: feature/dev-setup
Labels: enhancement, setup