Skip to content

neeraj2710/BlogHub

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
.mvn/wrapper
.mvn/wrapper
 
 
src
src
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
mvnw
mvnw
 
 
mvnw.cmd
mvnw.cmd
 
 
pom.xml
pom.xml
 
 

Repository files navigation

📝 BlogHub — Full-Stack Blogging Platform

A full-stack blogging platform with a Vanilla JS + HTML/CSS frontend and a Spring Boot REST API backend. Authors can register, write posts, manage categories (admin only), and search/browse content seamlessly.

Java Spring Boot MySQL JavaScript HTML5 CSS3 Maven

📚 Table of Contents

🛠 Tech Stack

Frontend

Layer Technology
Markup HTML5
Styling CSS3 (Custom Properties, Flexbox, Grid)
Scripting Vanilla JavaScript (ES6+)
HTTP Client Fetch API
Routing Client-side (hash-based)
State Session Cookie (JSESSIONID)

Backend

Layer Technology
Framework Spring Boot 4.0.4
Language Java 25
Database MySQL 8
ORM Spring Data JPA / Hibernate
Auth Session-based (HttpSession)
Validation Jakarta Bean Validation
Build Tool Maven

✨ Features

  • 🔐 User registration & session-based login / logout
  • 📝 Full CRUD for blog posts with pagination, sorting, and full-text search
  • 🗂️ Category management — read for all users, write for ADMIN only
  • 👤 Author profile management with role-based access control
  • 🌐 Interactive frontend — no framework, pure HTML/CSS/JS
  • ⚠️ Global exception handling with structured error responses

🧩 Use Case Diagram

graph TD
    Guest([Guest])
    User([Authenticated User])
    Admin([Admin])

    Guest --> UC1[Register]
    Guest --> UC2[Login]
    Guest --> UC3[Browse Posts]
    Guest --> UC4[Search Posts]
    Guest --> UC5[View Categories]

    User --> UC2
    User --> UC6[Logout]
    User --> UC7[View My Profile]
    User --> UC8[Update My Profile]
    User --> UC9[Create Post]
    User --> UC10[Update Own Post]
    User --> UC11[Delete Own Post]
    User --> UC12[View My Posts]
    User --> UC3
    User --> UC4
    User --> UC5

    Admin --> UC13[Create Category]
    Admin --> UC14[Update Category]
    Admin --> UC15[Delete Category]
    Admin --> UC16[Delete Any Post]
    Admin --> UC17[Delete Any User]
    Admin --> UC7
    Admin --> UC8
    Admin --> UC9
    Admin --> UC3
Loading

🗃️ ER Diagram

erDiagram
    AUTHORS {
        BIGINT id PK
        VARCHAR name
        VARCHAR email UK
        VARCHAR password
        VARCHAR role
        VARCHAR about
    }

    CATEGORIES {
        BIGINT id PK
        VARCHAR cat_name UK
        VARCHAR description
    }

    POSTS {
        BIGINT id PK
        VARCHAR title
        LONGTEXT content
        DATETIME created_at
        BIGINT author_id FK
        BIGINT category_id FK
    }

    AUTHORS ||--o{ POSTS : "writes"
    CATEGORIES ||--o{ POSTS : "contains"
Loading

🔄 Data Flow Diagram

Level 0 — Context Diagram

graph LR
    Client([Client / Browser]) -- HTTP Request --> BlogHub[BlogHub REST API]
    BlogHub -- HTTP Response --> Client
    BlogHub -- CRUD --> DB[(MySQL Database)]
Loading

Level 1 — Internal Data Flow

flowchart TD
    Client([Client])

    subgraph Frontend
        FE[HTML / CSS / JS Pages]
        FA[Fetch API Calls]
    end

    subgraph API Layer
        AC[AuthController\n/api/auth]
        UC[AuthorController\n/api/users]
        CC[CategoryController\n/api/categories]
        PC[PostController\n/api/posts]
    end

    subgraph Middleware
        SI[SessionAuthInterceptor\nChecks session & role]
    end

    subgraph Service Layer
        AS[AuthService]
        US[AuthorService]
        CS[CategoryService]
        PS[PostService]
    end

    subgraph Repository Layer
        AR[AuthorRepository]
        CR[CategoryRepository]
        PR[PostRepository]
    end

    DB[(MySQL\nbloghub_db)]

    Client --> FE --> FA
    FA -- "POST /register\nPOST /login" --> AC
    FA -- "All other /api/**" --> SI
    SI -- "401 if no session\n403 if not ADMIN" --> Client
    SI --> UC & CC & PC

    AC --> AS
    UC --> US
    CC --> CS
    PC --> PS

    AS --> AR
    US --> AR
    CS --> CR
    PS --> PR & AR & CR

    AR & CR & PR --> DB
Loading

Request-Response Flow (Login Example)

sequenceDiagram
    participant B as Browser (JS)
    participant AC as AuthController
    participant AS as AuthService
    participant AR as AuthorRepository
    participant DB as MySQL

    B->>AC: POST /api/auth/login {email, password}
    AC->>AS: login(LoginRequestDto, HttpSession)
    AS->>AR: findByEmail(email)
    AR->>DB: SELECT * FROM authors WHERE email=?
    DB-->>AR: Author row
    AR-->>AS: Optional<Author>
    AS-->>AS: Validate password match
    AS-->>AS: session.setAttribute(userId, role, ...)
    AS-->>AC: AuthResponseDto
    AC-->>B: 200 OK + Set-Cookie: JSESSIONID
Loading

📁 Directory Structure

BlogHub/
├── pom.xml
├── .mvn/
│   └── wrapper/
│       └── maven-wrapper.properties
└── src/
    ├── main/
    │   ├── java/com/mardox/bloghub/
    │   │   ├── BlogHubApplication.java             # Entry point
    │   │   ├── config/
    │   │   │   └── WebConfig.java                  # Registers interceptor
    │   │   ├── controller/
    │   │   │   ├── AuthController.java              # /api/auth
    │   │   │   ├── AuthorController.java            # /api/users
    │   │   │   ├── CategoryController.java          # /api/categories
    │   │   │   └── PostController.java              # /api/posts
    │   │   ├── dto/
    │   │   │   ├── AuthResponseDto.java
    │   │   │   ├── AuthorResponseDto.java
    │   │   │   ├── AuthorUpdateDto.java
    │   │   │   ├── CategoryRequestDto.java
    │   │   │   ├── CategoryResponseDto.java
    │   │   │   ├── CategoryUpdateDto.java
    │   │   │   ├── LoginRequestDto.java
    │   │   │   ├── PostRequestDto.java
    │   │   │   ├── PostResponseDto.java
    │   │   │   ├── PostUpdateDto.java
    │   │   │   └── RegisterRequestDto.java
    │   │   ├── entity/
    │   │   │   ├── Author.java                     # authors table
    │   │   │   ├── Category.java                   # categories table
    │   │   │   └── Post.java                       # posts table
    │   │   ├── exception/
    │   │   │   ├── ErrorResponse.java
    │   │   │   ├── GlobalExceptionHandler.java
    │   │   │   ├── ResouceAlreadyExistsException.java
    │   │   │   └── ResourceNotFoundException.java
    │   │   ├── interceptor/
    │   │   │   └── SessionAuthInterceptor.java     # Auth guard
    │   │   ├── repository/
    │   │   │   ├── AuthorRepository.java
    │   │   │   ├── CategoryRepository.java
    │   │   │   └── PostRepository.java
    │   │   └── service/
    │   │       ├── AuthService.java
    │   │       ├── AuthorService.java
    │   │       ├── CategoryService.java
    │   │       └── PostService.java
    │   └── resources/
    │       ├── static/                             # Frontend (HTML/CSS/JS)
    │       │   ├── index.html
    │       │   ├── css/
    │       │   └── js/
    │       └── application.properties
    └── test/
        └── java/com/mardox/bloghub/
            └── BlogHubApplicationTests.java

📡 API Reference

Base URL: http://localhost:8082

All endpoints except /api/auth/** require an active session (cookie JSESSIONID).

🔑 Auth — /api/auth

Method Endpoint Auth Required Description
POST /api/auth/register ❌ Register a new author
POST /api/auth/login ❌ Login, starts session
POST /api/auth/logout ✅ Invalidate session
GET /api/auth/me ✅ Get current logged-in user

👤 Authors — /api/users

Method Endpoint Auth Required Role Description
GET /api/users ✅ Any List all authors
GET /api/users/{id} ✅ Any Get author by ID
PUT /api/users/{id} ✅ Self/Admin Update author profile
DELETE /api/users/{id} ✅ Self/Admin Delete author

🗂️ Categories — /api/categories

Method Endpoint Auth Required Role Description
GET /api/categories ✅ Any List all categories
GET /api/categories/{id} ✅ Any Get category by ID
POST /api/categories ✅ ADMIN Create category
PUT /api/categories/{id} ✅ ADMIN Update category
DELETE /api/categories/{id} ✅ ADMIN Delete category

📝 Posts — /api/posts

Method Endpoint Auth Required Role Description
GET /api/posts ✅ Any Paginated posts (page, size, sortBy, sortDir)
GET /api/posts/getAll ✅ Any All posts or search (?term=keyword)
GET /api/posts/{id} ✅ Any Get post by ID
GET /api/posts/my-post ✅ Any Get current user's posts
POST /api/posts ✅ Any Create post
PUT /api/posts/{id} ✅ Self/Admin Update post
DELETE /api/posts/{id} ✅ Self/Admin Delete post

⚠️ Error Responses

HTTP Status Scenario
400 Validation failure
401 No active session
403 Insufficient role (non-admin)
404 Resource not found / already exists
500 Unhandled server error 
{
  "statusCode": 404,
  "errorMessage": "Author not found with id: 5"
}

🚀 Getting Started

Prerequisites

  • Java 21+
  • Maven 3.9+
  • MySQL 8 running locally

Setup

1. Clone the repository

git clone https://github.com/neeraj2710/BlogHub.git
cd BlogHub

2. Configure the database

Edit src/main/resources/application.properties:

spring.datasource.url=jdbc:mysql://localhost:3306/bloghub_db?createDatabaseIfNotExist=true
spring.datasource.username=your_mysql_username
spring.datasource.password=your_mysql_password

3. Run the application

./mvnw spring-boot:run

4. Open in browser

http://localhost:8082

The database schema is auto-created by Hibernate on first run (ddl-auto=update).

🧪 Quick Test (cURL)

# Register
curl -c cookies.txt -X POST http://localhost:8082/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{"name":"Alice","email":"alice@example.com","password":"pass123","about":"Developer"}'

# Login
curl -c cookies.txt -X POST http://localhost:8082/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"alice@example.com","password":"pass123"}'

# Create a post (requires a category to exist first)
curl -b cookies.txt -X POST http://localhost:8082/api/posts \
  -H "Content-Type: application/json" \
  -d '{"title":"Hello World","content":"My first post.","categoryId":1}'

🔒 Session Management

Attribute Value
Session timeout 30 minutes
Cookie name JSESSIONID
HTTP-only Yes
Same-site Lax

Session attributes set on login: userId, userName, userEmail, userRole

👥 Roles & Permissions

Role Permissions
USER CRUD own posts · Read-only on categories · Manage own profile
ADMIN All USER permissions + manage all categories · Delete any post or user
Made with ❤️ by Neeraj

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

3 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages