Merge pull request #31 from JAQStack/develop

thesurenk · web-flow · commit 61656edf2592 · 2025-11-09T09:10:04.000-06:00
updates from develop
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,9 @@
 *.idea
 .idea/
 
+# VS Code files
+.vscode/
+
 # Eclipse files
 .settings/
 .project
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/README.md b/README.md
@@ -14,17 +14,18 @@ JAQ Stack is a full-stack development framework that combines:
 ## 🏗️ The Technology Stack
 
 ### Backend Technologies
-- **Java 11+** - Modern Java with latest features
+- **Java 11-21** - Modern Java with latest features (examples use Java 11+ or Java 21)
+- **Helidon MP** - MicroProfile framework for microservices (used in Simple Blog)
 - **Maven 3.6+** - Dependency management and build automation
 - **RESTful APIs** - Clean, scalable web services
 - **JWT Authentication** - Secure token-based authentication
 - **MongoDB/SQL** - Flexible database options
 
 ### Frontend Technologies
-- **Angular 14+** - Modern reactive frontend framework
+- **Angular 14-20** - Modern reactive frontend framework (examples use Angular 14+ or Angular 20)
 - **TypeScript** - Type-safe JavaScript development
 - **Angular CLI** - Command-line interface for Angular
-- **Node.js 14+** - JavaScript runtime for development tools
+- **Node.js 18+** - JavaScript runtime for development tools
 
 ### Development Tools
 - **Maven Tomcat Plugin** - Embedded development server
@@ -76,11 +77,11 @@ JAQ Stack follows a modern, layered architecture:
 ### Prerequisites
 Before getting started, ensure you have:
 
-- **Java 11+** - [Download](https://www.oracle.com/java/technologies/downloads/)
-- **Node.js 14+** - [Download](https://nodejs.org/)
+- **Java 11+** (Java 21 recommended for Simple Blog) - [Download](https://www.oracle.com/java/technologies/downloads/)
+- **Node.js 18+** - [Download](https://nodejs.org/)
 - **Angular CLI** - `npm install -g @angular/cli`
 - **Maven 3.6+** - [Download](https://maven.apache.org/download.cgi)
-- **MongoDB** (optional) - [Download](https://www.mongodb.com/try/download/community)
+- **MongoDB** (optional, required for some examples) - [Download](https://www.mongodb.com/try/download/community)
 
 ### Getting Started
 
@@ -92,14 +93,22 @@ Before getting started, ensure you have:
 
 2. **Explore the examples**
    ```bash
-   # Basic Authentication example
+   # Basic Authentication example (Tomcat-based)
    cd examples/basicauthentication
    mvn clean package
    mvn tomcat7:run
+   # Access at http://localhost:8080/basicauth
+   
+   # Simple Blog example (Helidon MP)
+   cd examples/simpleblog
+   mvn clean package
+   java -jar target/simpleblog.jar
+   # Access at http://localhost:8080
    ```
 
-3. **Access the application**
-   - Open your browser to `http://localhost:8080/basicauth`
+3. **Access the applications**
+   - Each example has its own README with specific instructions
+   - Check the [Available Examples](#-available-examples) section for details
 
 ## 📁 Project Structure
 
@@ -112,38 +121,28 @@ jaqstack-examples/
 ├── examples/                       # Example applications
 │   ├── basicauthentication/       # Authentication example
 │   ├── azureblobviewer/           # Azure integration example
+│   ├── simpleblog/                # Simple blog with Helidon MP
 │   └── README.md                  # Examples documentation
 ├── docs/                          # Documentation
 └── README.md                      # This file
 ```
 
 ## 🎯 Available Examples
 
-### 🔐 [Basic Authentication](./examples/basicauthentication/)
-Complete authentication system with user management, JWT tokens, and MongoDB integration.
-
-**Features:**
-- User registration and login
-- JWT token-based authentication
-- MongoDB integration
-- Angular authentication guards
-- RESTful API endpoints
-
-### ☁️ [Azure Blob Viewer](./examples/azureblobviewer/)
-Azure Blob Storage integration for cloud file management and viewing.
-
-**Features:**
-- Azure Blob Storage integration
-- File upload and download
-- Image preview and management
-- RESTful API for blob operations
+| Example | Description | Key Features |
+|---------|-------------|--------------|
+| 🔐 [Basic Authentication](./examples/basicauthentication/) | Complete authentication system with user management, JWT tokens, and MongoDB integration. | User registration and login, JWT token-based authentication, MongoDB integration, Angular authentication guards, RESTful API endpoints |
+| ☁️ [Azure Blob Viewer](./examples/azureblobviewer/) | Azure Blob Storage integration for cloud file management and viewing. | Azure Blob Storage integration, File upload and download, Image preview and management, RESTful API for blob operations |
+| 📝 [Simple Blog](./examples/simpleblog/) | A simple blog application built with Java, Angular, Helidon, and MongoDB. | Create and read blog posts, RESTful API backend with Helidon MP, Modern Angular 20 frontend, MongoDB database integration, CORS support |
 
 ## 🛠️ Development Workflow
 
 ### Backend Development
 1. **Create Java services** in `src/main/java/`
 2. **Build with Maven** - `mvn clean package`
-3. **Run development server** - `mvn tomcat7:run`
+3. **Run development server** - 
+   - For Tomcat-based examples: `mvn tomcat7:run`
+   - For Helidon MP examples: `java -jar target/[app-name].jar`
 4. **Test APIs** using Postman or browser
 
 ### Frontend Development
@@ -153,15 +152,18 @@ Azure Blob Storage integration for cloud file management and viewing.
 4. **Build for production** - `ng build --prod`
 
 ### Full-Stack Development
-1. **Start backend** - `mvn tomcat7:run`
+1. **Start backend** - 
+   - Tomcat-based: `mvn tomcat7:run`
+   - Helidon MP: `java -jar target/[app-name].jar`
 2. **Start frontend** - `cd ui.resources && ng serve`
-3. **Access application** - `http://localhost:4200`
+3. **Access application** - `http://localhost:4200` (frontend) or `http://localhost:8080` (backend API)
 
 ## 🏗️ Built With
 
 JAQ Stack is built using industry-standard tools and frameworks:
 
 - **Maven Archetype Webapp** - Standard Java web application structure
+- **Helidon MP** - MicroProfile framework for microservices
 - **Angular CLI** - Modern Angular development tools
 - **Bootstrap Themes** - Professional UI components
 - **Initializr** - Modern web app boilerplate
diff --git a/examples/README.md b/examples/README.md
@@ -19,54 +19,22 @@ JAQ Stack is a full-stack development framework that combines:
 
 ## 🎯 Available Examples
 
-### 1. [Basic Authentication](./basicauthentication/)
-**Description**: Complete authentication system with user registration, login, and JWT token management.
-
-**Features**:
-- User registration and login
-- JWT token-based authentication
-- MongoDB integration
-- Angular frontend with authentication guards
-- RESTful API endpoints
-
-**Technologies**: Java, Angular, MongoDB, JWT, Maven
-
-**Quick Start**:
-```bash
-cd examples/basicauthentication
-mvn clean package
-mvn tomcat7:run
-```
-
-### 2. [Azure Blob Viewer](./azureblobviewer/)
-**Description**: Azure Blob Storage integration for viewing and managing cloud storage files.
-
-**Features**:
-- Azure Blob Storage integration
-- File upload and download
-- Image preview and management
-- RESTful API for blob operations
-- Angular frontend with file management
-
-**Technologies**: Java, Angular, Azure Blob Storage, Maven
-
-**Quick Start**:
-```bash
-cd examples/azureblobviewer
-mvn clean package
-mvn tomcat7:run
-```
+| Example | Description | Key Features | Technologies |
+|---------|-------------|--------------|--------------|
+| 🔐 [Basic Authentication](./basicauthentication/) | Complete authentication system with user registration, login, and JWT token management. | User registration and login, JWT token-based authentication, MongoDB integration, Angular frontend with authentication guards, RESTful API endpoints | Java, Angular, MongoDB, JWT, Maven |
+| ☁️ [Azure Blob Viewer](./azureblobviewer/) | Azure Blob Storage integration for viewing and managing cloud storage files. | Azure Blob Storage integration, File upload and download, Image preview and management, RESTful API for blob operations, Angular frontend with file management | Java, Angular, Azure Blob Storage, Maven |
+| 📝 [Simple Blog](./simpleblog/) | A simple blog application built with Java, Angular, Helidon, and MongoDB. | Create and read blog posts, RESTful API backend with Helidon MP, Modern Angular 20 frontend, MongoDB database integration, CORS support | Java 21, Helidon MP 4.3.1, Angular 20, MongoDB, Maven |
 
 ## 🚀 Quick Start
 
 ### Prerequisites
 Before running any example, ensure you have:
 
-- **Java 11+** - [Download](https://www.oracle.com/java/technologies/downloads/)
-- **Node.js 14+** - [Download](https://nodejs.org/)
+- **Java 11+** (Java 21 recommended for Simple Blog) - [Download](https://www.oracle.com/java/technologies/downloads/)
+- **Node.js 18+** - [Download](https://nodejs.org/)
 - **Angular CLI** - `npm install -g @angular/cli`
 - **Maven 3.6+** - [Download](https://maven.apache.org/download.cgi)
-- **MongoDB** (for Basic Authentication example) - [Download](https://www.mongodb.com/try/download/community)
+- **MongoDB** (required for Basic Authentication and Simple Blog examples) - [Download](https://www.mongodb.com/try/download/community)
 
 ### Running an Example
 
@@ -85,13 +53,25 @@ Before running any example, ensure you have:
    ```
 
 4. **Build and run**
+   
+   **For Tomcat-based examples** (Basic Authentication, Azure Blob Viewer):
    ```bash
    mvn clean package
    mvn tomcat7:run
+   # Access at http://localhost:8080/[example-name]
+   ```
+   
+   **For Helidon MP examples** (Simple Blog):
+   ```bash
+   mvn clean package
+   java -jar target/simpleblog.jar
+   # Access at http://localhost:8080
    ```
 
 5. **Access the application**
-   - Open your browser to `http://localhost:8080/[example-name]`
+   - Tomcat-based examples: `http://localhost:8080/[example-name]`
+   - Helidon MP examples: `http://localhost:8080`
+   - Frontend development: `http://localhost:4200` (when running `ng serve`)
 
 ## 📁 Project Structure
 
@@ -127,18 +107,22 @@ examples/
 ### For Backend Development
 1. Make changes to Java code in `src/main/java/`
 2. Run `mvn clean package` to build
-3. Use `mvn tomcat7:run` for development server
+3. Run development server:
+   - **Tomcat-based examples**: `mvn tomcat7:run`
+   - **Helidon MP examples**: `java -jar target/[app-name].jar`
 
 ### For Frontend Development
 1. Navigate to `ui.resources/`
 2. Run `ng serve` for development server
 3. Run `ng build --prod` for production build
 
 ### Full Stack Development
-1. Start MongoDB (if required)
-2. Run backend: `mvn tomcat7:run`
+1. Start MongoDB (if required for the example)
+2. Run backend:
+   - **Tomcat-based**: `mvn tomcat7:run`
+   - **Helidon MP**: `java -jar target/[app-name].jar`
 3. Run frontend: `cd ui.resources && ng serve`
-4. Access at `http://localhost:4200` (Angular) or `http://localhost:8080` (Java)
+4. Access at `http://localhost:4200` (Angular frontend) or `http://localhost:8080` (backend API)
 
 ## 🆘 Getting Help
 
@@ -160,7 +144,9 @@ examples/
 
 ## 🎯 Next Steps
 
-1. **Explore Examples**: Start with the Basic Authentication example
+1. **Explore Examples**: 
+   - Start with the **Basic Authentication** example for traditional Tomcat-based apps
+   - Try the **Simple Blog** example for modern Helidon MP microservices
 2. **Customize**: Modify examples to fit your needs
 3. **Build**: Create your own JAQ Stack applications
 4. **Contribute**: Share improvements and new examples
