Getting Started
Learn how to set up and start using JAngular CLI for your full-stack projects. This guide will walk you through installation, configuration, and creating your first project.
Quick Start
Get up and running with JAngular CLI in under 5 minutes:
# Install JAngular CLI globally npm install -g jangular-cli # Create a new project jangular init my-awesome-app # Navigate and install dependencies cd my-awesome-app && npm run install:all # Start development servers npm run start:backend # Terminal 1 npm run start:frontend # Terminal 2
Prerequisites
Node.jsv18+
JavaScript runtime for Angular development
Javav21+
OpenJDK or Oracle JDK for Spring Boot
Angular CLIv17+
Official Angular command line interface
Maven3.x+
Build automation tool for Java projects
System Check
Run jangular --test to verify your system meets all requirements before creating a project.
Installation
1. Verify Prerequisites
# Check Node.js version (v18+ required) node --version # Check Java version (v21+ required) java -version # Install Angular CLI globally npm install -g @angular/cli@^17.0.0
2. Install JAngular CLI
npm install -g jangular-cli
3. Verify Installation
jangular --version jangular --help
Creating Your First Project
The JAngular CLI will guide you through an interactive setup process:
Initialize Project
Enter your project name and basic details
Java Configuration
Set group ID, artifact ID, and package name
Database Selection
Choose between MySQL, PostgreSQL, or MSSQL
Database Setup
Configure connection details and credentials
Complete Setup Command
# Create and setup a new project jangular init my-awesome-app # Navigate to your project cd my-awesome-app # Install all dependencies (backend + frontend) npm run install:all # Start development servers npm run start:backend # Spring Boot (port 8080) npm run start:frontend # Angular (port 4200)
Project Structure
After running jangular init, you'll have a well-organized full-stack project:
my-awesome-app/ ├── backend/ # Spring Boot Application │ ├── src/main/java/ # Java source code │ │ └── com/example/app/ # Your Java packages │ ├── src/main/resources/ # Configuration files │ │ ├── application.properties │ │ ├── application-mysql.properties │ │ └── db/migration/ # Database migrations │ ├── pom.xml # Maven configuration │ └── Dockerfile # Backend container config ├── frontend/ # Angular Application │ ├── src/app/ # Angular components & services │ │ ├── auth/ # Authentication module │ │ ├── components/ # Reusable components │ │ └── services/ # Business logic services │ ├── package.json # Node.js dependencies │ ├── angular.json # Angular CLI configuration │ └── Dockerfile # Frontend container config ├── docker-compose.yml # Multi-container setup ├── package.json # Root project scripts └── README.md # Project documentation
You're Ready!
Your JAngular project includes authentication, user management, database integration, and Docker configuration out of the box.