Skip to content

Commit acbbf3c

Browse files
committed
Refactor README.md and add getting-started.md for clearer migration instructions and setup guidance
1 parent 16f6496 commit acbbf3c

File tree

2 files changed

+72
-58
lines changed

2 files changed

+72
-58
lines changed

jakarta-ee/student-web-app/README.md

Lines changed: 15 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,25 @@
1-
# Open Liberty Ant Project
1+
# Migrate a legacy Java EE Ant project to a Jakarta EE 10 Maven project
22

3-
A Java EE web application running on Open Liberty with a hybrid architecture that supports both traditional servlets and Spring MVC. The application manages student profiles with CRUD operations and demonstrates migrating from Ant to Maven and Java EE to Jakarta EE.
4-
5-
## Project Architecture
6-
7-
See [project details](doc/architecture.md).
8-
9-
## Getting Started
10-
11-
### Prerequisites
12-
- **Java 11** or higher
13-
- **Apache Ant** (for building)
14-
- **Docker & Docker Compose** (recommended)
15-
16-
### Quick Start (Docker - Recommended)
3+
This workshop guides you through migrating a legacy Java EE Ant project to a Jakarta EE 10 Maven project. After completing the workshop, the project will be fully migrated from Java EE to Jakarta EE 10, upgraded from Spring Framework 5.3.39 to 6.2.x, and ready to build with Maven.
174

18-
1. **Clone and navigate to the project:**
19-
```bash
20-
cd student-web-app
21-
```
5+
## About this Sample Project
226

23-
2. **Run setup script:**
24-
```bash
25-
# Linux/Mac
26-
./setup-docker.sh
27-
28-
# Windows
29-
setup-docker.bat
30-
```
31-
32-
3. **Start the application:**
33-
```bash
34-
docker-compose up --build
35-
```
36-
37-
4. **Access the application:**
38-
- Home page: http://localhost:9080/
39-
40-
### Manual Setup (Without Docker)
41-
42-
See [maunual setup](doc/manual-setup.md).
43-
44-
### Verification
7+
A Java EE web application running on Open Liberty with a hybrid architecture that supports both traditional servlets and Spring MVC. The application manages student profiles with CRUD operations and demonstrates migrating from Ant to Maven and Java EE to Jakarta EE.
458

46-
Test the application with:
47-
```bash
48-
# Add a student
49-
curl -X POST "http://localhost:9080/app/add-student" \
50-
-d "name=Alice Johnson" \
51-
52-
-d "major=Biology"
9+
For the project architecture, see [project details](doc/architecture.md).
10+
For how to start this project, see [getting started](doc/getting-started.md)
5311

54-
# View students
55-
curl http://localhost:9080/studentProfileList
56-
# or
57-
# curl http://localhost:9080/app/students
58-
```
12+
## Prerequisites
5913

60-
**Student Profiles List View:**
61-
Access the pages from browser: http://localhost:9080/
14+
- **Java 17** or higher
15+
- **Apache Ant**, tested version: `1.10.14`.
16+
- **Maven**, tested version: `3.8.7`.
17+
- **Docker & Docker Compose** (Optional, for running the sample application)
18+
- [Visual Studio Code](https://code.visualstudio.com/download)
19+
- [VS Code Extension: GitHub Copilot App Modernization](https://marketplace.visualstudio.com/items?itemName=vscjava.migrate-java-to-azure)
20+
- This extension depends on [VS Code Extension: GitHub Copilot App Modernization – Upgrade for Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-upgrade). Both extensions will be installed automatically when you install **GitHub Copilot App Modernization**.
6221

63-
<div align="left">
64-
<img src="assets/student_profiles_list.png" alt="Student Profiles List" width="50%"/>
65-
</div>
22+
## Assess the Project
6623

6724

6825

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
## Getting Started
2+
3+
### Prerequisites
4+
- **Java 11** or higher
5+
- **Apache Ant** (for building)
6+
- **Docker & Docker Compose** (recommended)
7+
8+
### Quick Start (Docker - Recommended)
9+
10+
1. **Clone and navigate to the project:**
11+
```bash
12+
cd student-web-app
13+
```
14+
15+
2. **Run setup script:**
16+
```bash
17+
# Linux/Mac
18+
./setup-docker.sh
19+
20+
# Windows
21+
setup-docker.bat
22+
```
23+
24+
3. **Start the application:**
25+
```bash
26+
docker-compose up --build
27+
```
28+
29+
4. **Access the application:**
30+
- Home page: http://localhost:9080/
31+
32+
### Manual Setup (Without Docker)
33+
34+
See [maunual setup](manual-setup.md).
35+
36+
### Verification
37+
38+
Test the application with:
39+
```bash
40+
# Add a student
41+
curl -X POST "http://localhost:9080/app/add-student" \
42+
-d "name=Alice Johnson" \
43+
44+
-d "major=Biology"
45+
46+
# View students
47+
curl http://localhost:9080/studentProfileList
48+
# or
49+
# curl http://localhost:9080/app/students
50+
```
51+
52+
**Student Profiles List View:**
53+
Access the pages from browser: http://localhost:9080/
54+
55+
<div align="left">
56+
<img src="assets/student_profiles_list.png" alt="Student Profiles List" width="50%"/>
57+
</div>

0 commit comments

Comments
 (0)