template-java-17-spring-oracle

About the Project

Welcome to the template-java-17-spring-oracle repository! This template application is crafted by Rodrigo Dantas, a Brazilian software engineer, with the aim to showcase the very best practices in Java 17, Spring Boot, and Oracle Database. This project serves as a portfolio piece and an exemplary guide for newbies stepping into the world of clean architecture.

About Me

Hello, I'm Rodrigo Dantas, the tech nerd behind this project. With a passion for crafting clean, efficient, and scalable code, I dedicate myself to helping others grow in their software engineering journey. Feel free to reach out to me if you have any questions, need assistance, or just want to talk tech!

Contact me:

I'm here to help, so don't hesitate to contact me via email or any of my social networks. Let's embark on this coding adventure together!

Table of Contents

Theory

• Project Structure and Clean Architecture
  • Project Structure
  • Explanation of Clean Architecture and SOLID Principles
    • Adapters Layer
      • Controller
      • Exception
    • Application Layer
      • DTO (Data Transfer Object)
      • Mapper
      • Use Case
    • Domain Layer
      • Entity
      • Repository
      • Specification
    • Shared Layer
      • Exception
      • Validation
      • Utils
    • Infrastructure Layer
      • Config
    • Authentication Workflow
      • Overview
      • Authentication Process
        • Step 1: User Login
        • Step 2: JWT Token Generation
        • Step 3: Token Validation
        • Step 4: Secure Access
      • Configuration
        • JWT Properties
        • Security Configuration
      • Testing Authentication
    • SOLID Principles Applied

Usage & Deploy

• Running the Application with Docker Compose

  • Prerequisites
  • Step 1: Clone the Repository
  • Step 2: Configure Environment Variables
  • Step 3: Running the Application
    • Option 1: Run Backend + Oracle Database from Docker Compose
    • Option 2: Run Backend with External Database
    • Using start-docker-compose.sh and start-docker-compose.ps1 Scripts
  • Database Access

• Running the Application in a DevContainer

  • Prerequisites
  • Step 1: Clone the Repository
  • Step 2: Configure Environment Variables
  • Step 3: Open the Project in VSCode
  • Step 4: Reopen in Container
  • Step 5: Wait for the Dev Container to Build and Start
  • Step 6: Run the Application
  • Step 7: Access the Application
  • Database Access
  • Accessing Swagger Endpoint Outside the Container

• Build, Test, and Deploying the Application (GitHub Actions)

  • Build and Test Workflow
    • Build and Test Workflow
    • How to Check the Workflow
  • Deploying the Application
    • Choosing a Cloud Provider
    • Setting Up Secrets
    • Deployment Workflow
    • How It Works
    • How to Check the Deployment Workflow

Happy coding!