Workshop Management Platform

A comprehensive SaaS backend solution for small and medium-sized businesses that offer workshops, courses, and training services. Built with Spring Boot 3.3 and PostgreSQL, this platform enables business owners to manage instructors, customers, courses, enrollments, and financial operations from a single, secure API.

🎯 Overview

The Workshop Management Platform provides a multi-tenant architecture where each business account has complete data isolation. Business owners can:

• Manage Instructors - Add, update, and track instructors with their specializations
• Manage Customers - Maintain a customer database with contact information (CRM)
• Manage Courses - Create workshops with pricing, capacity, scheduling, and instructor assignments
• Handle Enrollments - Register customers to courses and track payment status
• Track Finances - Automatic income recording from paid enrollments, manual income/expense entries, and financial summaries

🏗️ Architecture

src/main/java/com/bartugcelebi/workshopmanagment/
├── config/          # Security, CORS, OpenAPI configurations
├── controller/      # REST API endpoints
├── dto/             # Data Transfer Objects (Request/Response)
├── exception/       # Global exception handling
├── jwt/             # JWT authentication filters
├── mapper/          # MapStruct entity-DTO mappers
├── model/
│   ├── abstracts/   # Base entity classes
│   ├── entities/    # JPA entities
│   └── enums/       # Enumeration types
├── repository/      # Spring Data JPA repositories
└── service/
    ├── base/        # Base service interfaces
    ├── impl/        # Service implementations
    └── security/    # Security-related services

🛠️ Tech Stack

Category	Technology
Framework	Spring Boot 3.3.0
Language	Java 17
Database	PostgreSQL 15
Security	Spring Security + JWT (jjwt 0.11.5)
ORM	Spring Data JPA / Hibernate
Validation	Jakarta Bean Validation
Mapping	MapStruct 1.6.3
Documentation	SpringDoc OpenAPI (Swagger UI)
Build Tool	Maven
Containerization	Docker Compose
Code Generation	Lombok

📋 Prerequisites

• Java 17 or higher
• Maven 3.8+
• Docker & Docker Compose (for PostgreSQL)
• Git

🚀 Getting Started

1. Clone the Repository

git clone https://github.com/your-username/workshop-managment.git
cd workshop-managment

2. Configure Environment Variables

Create a .env file in the project root:

# Database Configuration
DB_NAME=workshop_db
DB_USER=postgres
DB_PASSWORD=your_secure_password

# JWT Configuration
JWT_SECRET_KEY=your_base64_encoded_secret_key_at_least_256_bits

⚠️ Security Note: Generate a strong secret key for production. The JWT secret should be at least 256 bits (32 characters) and Base64 encoded.

3. Start PostgreSQL Database

docker-compose up -d

This will start a PostgreSQL 15 container with the configured credentials.

4. Build and Run the Application

# Build the project
./mvnw clean install

# Run the application
./mvnw spring-boot:run

The application will start on http://localhost:8080.

5. Access API Documentation

Open your browser and navigate to:

• Swagger UI: http://localhost:8080/docs
• OpenAPI JSON: http://localhost:8080/v3/api-docs

📡 API Endpoints

Authentication

Method	Endpoint	Description
POST	/api/v1/auth/register	Register a new business account
POST	/api/v1/auth/login	Login and receive JWT tokens
POST	/api/v1/auth/refresh	Refresh access token

Instructors

Method	Endpoint	Description
GET	/api/v1/instructors	Get all instructors
GET	/api/v1/instructors/paged	Get instructors with pagination
GET	/api/v1/instructors/{id}	Get instructor by ID
POST	/api/v1/instructors	Create a new instructor
PUT	/api/v1/instructors/{id}	Update an instructor
DELETE	/api/v1/instructors/{id}	Delete an instructor

Customers

Method	Endpoint	Description
GET	/api/v1/customers	Get all customers
GET	/api/v1/customers/paged	Get customers with pagination
GET	/api/v1/customers/{id}	Get customer by ID
POST	/api/v1/customers	Create a new customer
PUT	/api/v1/customers/{id}	Update a customer
DELETE	/api/v1/customers/{id}	Delete a customer

Courses

Method	Endpoint	Description
GET	/api/v1/courses	Get all courses
GET	/api/v1/courses/paged	Get courses with pagination
GET	/api/v1/courses/{id}	Get course by ID
POST	/api/v1/courses	Create a new course
PUT	/api/v1/courses/{id}	Update a course
DELETE	/api/v1/courses/{id}	Delete a course

Enrollments

Method	Endpoint	Description
POST	/api/v1/enrollments	Enroll a customer in a course
PATCH	/api/v1/enrollments/{id}/payment	Update payment status

Financial Transactions

Method	Endpoint	Description
GET	/api/v1/transactions	Get all transactions
POST	/api/v1/transactions/manual	Create a manual transaction
GET	/api/v1/transactions/summary	Get financial summary for date range

🔐 Authentication

The API uses JWT (JSON Web Tokens) for authentication. After registering or logging in, you'll receive:

• Access Token: Short-lived token for API requests
• Refresh Token: Long-lived token to obtain new access tokens

Using the Token

Include the access token in the Authorization header:

Authorization: Bearer <your_access_token>

Example: Register a Business

curl -X POST http://localhost:8080/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "businessName": "Yoga Studio",
    "email": "contact@yogastudio.com",
    "password": "SecurePass123!",
    "phoneNumber": "+1234567890",
    "address": "123 Wellness Street"
  }'

🗃️ Data Model

┌─────────────┐       ┌─────────────┐       ┌─────────────┐
│  Business   │───────│ Instructor  │       │  Customer   │
│             │       │             │       │             │
│ - id        │       │ - id        │       │ - id        │
│ - name      │       │ - name      │       │ - name      │
│ - email     │       │ - specialty │       │ - email     │
│ - password  │       │ - businessId│       │ - phone     │
│ - phone     │       └─────────────┘       │ - businessId│
│ - address   │              │              └─────────────┘
└─────────────┘              │                     │
       │                     ▼                     │
       │              ┌─────────────┐              │
       │              │   Course    │              │
       │              │             │              │
       └──────────────│ - id        │              │
                      │ - title     │              │
                      │ - price     │              │
                      │ - capacity  │              │
                      │ - dates     │              │
                      │ - businessId│              │
                      │ - instructor│              │
                      └─────────────┘              │
                             │                    │
                             ▼                    ▼
                      ┌─────────────────────────────┐
                      │        Enrollment           │
                      │                             │
                      │ - id                        │
                      │ - customerId                │
                      │ - courseId                  │
                      │ - isPaid                    │
                      └─────────────────────────────┘
                                    │
                                    ▼
                      ┌─────────────────────────────┐
                      │   FinancialTransaction      │
                      │                             │
                      │ - id                        │
                      │ - amount                    │
                      │ - type (INCOME/EXPENSE)     │
                      │ - description               │
                      │ - transactionDate           │
                      │ - businessId                │
                      │ - enrollmentId (optional)   │
                      └─────────────────────────────┘

🔒 Security Features

• JWT-based Authentication: Stateless authentication with access and refresh tokens
• Password Encryption: BCrypt password hashing
• Data Isolation: Multi-tenant architecture ensures each business can only access their own data
• CORS Configuration: Configurable cross-origin resource sharing
• Input Validation: Request validation using Jakarta Bean Validation

📊 Financial Management

The platform automatically tracks finances:

1. Automatic Income: When an enrollment is marked as "paid", the course fee is automatically recorded as income
2. Manual Transactions: Record additional income (e.g., merchandise sales) or expenses (e.g., rent, utilities, supplies)
3. Financial Summary: Get total income, total expenses, and net profit for any date range

🧪 Testing

# Run all tests
./mvnw test

# Run with coverage report
./mvnw test jacoco:report

📁 Project Structure

workshop-managment/
├── src/
│   ├── main/
│   │   ├── java/com/bartugcelebi/workshopmanagment/
│   │   └── resources/
│   │       ├── application.properties
│   │       ├── static/
│   │       └── templates/
│   └── test/
├── .env                    # Environment variables (create this)
├── docker-compose.yml      # PostgreSQL container setup
├── pom.xml                 # Maven dependencies
├── mvnw                    # Maven wrapper (Unix)
├── mvnw.cmd                # Maven wrapper (Windows)
├── PRD.md                  # Product Requirements Document
└── TODO.md                 # Development roadmap

🚧 Roadmap

• Unit tests for service layer (JUnit & Mockito)
• Integration tests for controllers (MockMvc)
• Email notifications for enrollments
• Public course listing page
• Calendar-based scheduling interface
• Payment gateway integration

👤 Author

Bartuğ Kaan Çelebi

• GitHub: @BartugKaan

---

Made with ❤️ using Spring Boot