Skip to content

README.md

Latest commit

 

History

History
156 lines (122 loc) · 5.93 KB

README.md

File metadata and controls

156 lines (122 loc) · 5.93 KB

JAQ Stack Examples

This repository contains comprehensive examples and sample applications built with the JAQ Stack framework. JAQ Stack combines Java backend services with Angular frontend applications to create modern, full-stack web applications.

🚀 What is JAQ Stack?

JAQ Stack is a full-stack development framework that combines:

  • Java - Backend services and REST APIs
  • Angular - Modern frontend framework
  • Quick - Rapid development and deployment

📋 Table of Contents

🎯 Available Examples

Example Description Key Features Technologies
🔐 Basic Authentication 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 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 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+ (Java 21 recommended for Simple Blog) - Download
  • Node.js 18+ - Download
  • Angular CLI - npm install -g @angular/cli
  • Maven 3.6+ - Download
  • MongoDB (required for Basic Authentication and Simple Blog examples) - Download

Running an Example

  1. Choose an example from the list above

  2. Navigate to the example directory

    cd examples/[example-name]

  3. Install dependencies (if needed)

    cd ui.resources
npm install
ng build --prod
cd ..

  4. Build and run

    For Tomcat-based examples (Basic Authentication, Azure Blob Viewer):

    mvn clean package
mvn tomcat7:run
# Access at http://localhost:8080/[example-name]

    For Helidon MP examples (Simple Blog):

    mvn clean package
java -jar target/simpleblog.jar
# Access at http://localhost:8080

  5. Access the application

    • 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

Each example follows a consistent structure:

examples/
├── [example-name]/
│   ├── src/main/java/          # Java backend code
│   ├── src/main/webapp/        # Web resources and JSPs
│   ├── ui.resources/           # Angular frontend
│   │   ├── src/app/           # Angular components and services
│   │   ├── package.json       # Node.js dependencies
│   │   └── dist/              # Built Angular assets
│   ├── pom.xml                # Maven configuration
│   └── README.md              # Example-specific documentation

Backend Structure

  • Java Services: RESTful APIs and business logic
  • Servlets: HTTP request handling
  • Models: Data transfer objects
  • Configuration: Maven and web.xml settings

Frontend Structure

  • Angular Components: UI components and pages
  • Services: API communication and business logic
  • Models: TypeScript interfaces and types
  • Assets: CSS, images, and static resources

🔧 Development Workflow

For Backend Development

  1. Make changes to Java code in src/main/java/
  2. Run mvn clean package to build
  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 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 frontend) or http://localhost:8080 (backend API)

🆘 Getting Help

Documentation

  • Each example has its own detailed README.md
  • Check the specific example directory for setup instructions
  • Review the troubleshooting sections for common issues

Common Issues

  • Port conflicts: Change ports in configuration files
  • MongoDB connection: Ensure MongoDB is running
  • Angular CLI issues: Update to latest version
  • Build failures: Clean and rebuild with mvn clean package

Support

  • Check the main project repository for issues and discussions
  • Review example-specific documentation for detailed setup instructions
  • Ensure all prerequisites are properly installed

🎯 Next Steps

  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

Happy Coding with JAQ Stack! 🚀