Getting Started
Start here if you want the fastest path from zero to a running AWE application. This guide gives you the happy path, then points you to deeper reference docs.
Quick path​
- Install Java 21+ and Maven 3.x.
- Choose the AngularJS or React archetype.
- Generate your project with Maven.
- Run the app with Spring Boot.
- Confirm the generated application starts on
http://localhost:18080.
Prerequisites​
- JDK 21 or higher
- Maven 3.x or higher
- Your preferred IDE or editor
Choose your archetype​
React is the modern client of AWE 5 and the recommended one for new projects. The AngularJS client stays supported in compatibility mode through the whole 5.x line, so existing AngularJS projects keep it when they upgrade. See ADR 001: React is the modern client of AWE 5.
| Option | Archetype | Use it when |
|---|---|---|
| React (recommended) | awe-boot-react-archetype | You start a new project |
| AngularJS | awe-boot-angular-archetype | You keep the classic AWE AngularJS stack, for example to match an existing project |
Use the current AWE version from Maven Central: 
Generate your project​
AngularJS project​
mvn -B archetype:generate \
-DarchetypeGroupId=com.almis.awe \
-DarchetypeArtifactId=awe-boot-angular-archetype \
-DarchetypeVersion=[Archetype version] \
-DgroupId=com.mycompany.app \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT
React project​
mvn -B archetype:generate \
-DarchetypeGroupId=com.almis.awe \
-DarchetypeArtifactId=awe-boot-react-archetype \
-DarchetypeVersion=[Archetype version] \
-DgroupId=com.mycompany.app \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT
Run the generated application​
From the generated project directory:
mvn spring-boot:run
What to expect​
- The archetype creates a Maven-based AWE application.
- The generated app is configured to run on port
18080. - The default setup includes the standard AWE application structure under
src/main/resources/application/<your-acronym>/. - The generated configuration includes an embedded HSQLDB datasource so you can start locally without wiring an external database first.
Open http://localhost:18080 after startup and confirm the application loads without errors.
Next step after first run​
Continue with awe-101 Your first AWE App for the first hands-on tutorial. It picks up from this quick-start and shows you how to:
- understand the generated AWE folders,
- locate screens and menus,
- and make one small visible customization.
Where to go next​
Use these docs as follow-up references after the first run:
- Project Structure for the AWE XML layout and folders
- XSD tooling for XML autocompletion and validation in IntelliJ IDEA and VS Code
- Development container to build and test AWE from VS Code without installing a toolchain
- awe-101 Your first AWE App for the first practical tutorial after quick-start
- Installation for server and environment setup details
- Deployment for JAR, WAR, Docker, and cloud packaging options