prancodes/blogging-app repository overview

⁠BloggingProject 📝

A lightweight Spring Boot blogging application containerized for easy deployment. Demonstrates a full CRUD (Create, Read, Update, Delete) flow for articles using Spring Data JPA, Thymeleaf templates, and UUID primary keys stored as BINARY(16).

This project also features fully configured PWA (Progressive Web App) support.

⁠Quick Jump

• Prerequisites⁠
• Quick Start⁠
  • Run with Docker⁠
  • Run with Docker Compose⁠
• Configuration⁠
• Key Features⁠
• Tech Stack⁠
• Ports⁠
• Author⁠

⁠Prerequisites

• Docker Desktop⁠ installed on your system

⁠Quick Start

⁠Run with Docker

To quickly start the application and its database using Docker, run the following commands.

⁠1. Start MySQL Container

docker run -d \
  --name mysql-blog \
  -e MYSQL_ROOT_PASSWORD=root \
  -e MYSQL_DATABASE=blogdb \
  -e MYSQL_USER=bloguser \
  -e MYSQL_PASSWORD=password \
  -p 3306:3306 \
  mysql:8.0

⁠2. Start the Blogging Application

docker run -d \
  --name blogging-app \
  -p 8080:8080 \
  -e DB_URL=jdbc:mysql://mysql-blog:3306/blogdb?useSSL=false&serverTimezone=UTC \
  -e DB_USER=bloguser \
  -e DB_PASS=password \
  --link mysql-blog \
  prancodes/blogging-app:latest

⁠Run with Docker Compose

Create a docker-compose.yml file with the following content to orchestrate both services automatically:

version: '3.8'

services:
  app:
    image: prancodes/blogging-app:latest
    container_name: blog-spring-web
    ports:
      - "8080:8080"
    environment:
      - DB_URL=jdbc:mysql://db:3306/blogdb?useSSL=false&serverTimezone=UTC
      - DB_USER=bloguser
      - DB_PASS=password
      - SPRING_PROFILES_ACTIVE=dev
    depends_on:
      - db
    networks:
      - blog-network

  db:
    image: mysql:8.0
    container_name: blog-mysql-db
    environment:
      - MYSQL_ROOT_PASSWORD=root
      - MYSQL_DATABASE=blogdb
      - MYSQL_USER=bloguser
      - MYSQL_PASSWORD=password
    volumes:
      - db-data:/var/lib/mysql
    networks:
      - blog-network

volumes:
  db-data:

networks:
  blog-network:
    driver: bridge

Start the stack:

docker compose up -d

⁠Configuration

⁠Environment Variables

The container is configured using the following environment variables. You can override them at runtime.

⁠✨ Key Features

• Installable PWA: Fully configured site.webmanifest and Service Worker (sw.js) allow the app to be installed natively on Android, iOS, and Desktop.
• Complete CRUD Operations: Create, read, update, and delete articles through an intuitive web interface.
• UUID Primary Keys: Uses Java UUID with Hibernate GenerationType.UUID, optimized as BINARY(16) for performance.
• Input Validation: Client-side and server-side validation using Jakarta Validation annotations (@NotBlank, @Size).
• Server-Side Rendering: Built with Spring MVC and Thymeleaf templates for dynamic HTML generation.
• Profile-Based Configuration: Separate environment configurations for development and production.

⁠🛠️ Tech Stack

• Java 25 (LTS)
• Spring Boot 4.0.1 (Web, Thymeleaf, Data JPA, Validation)
• MySQL 8.0
• Docker & Docker Compose
• Thymeleaf Templates

⁠Ports

⁠Author

🧑🏻‍💻 Developed and maintained by Pranjal Singh⁠

Project source code is available on GitHub Repository⁠.