https://github.com/thibseisel/tomee-webapp-archetype
Maven archetype that allows quick creation and deployment of a webapp with a TomEE server and a MySQL database.
https://github.com/thibseisel/tomee-webapp-archetype
angular4 docker javaee maven-archetype tomee
Last synced: 6 months ago
JSON representation
Maven archetype that allows quick creation and deployment of a webapp with a TomEE server and a MySQL database.
- Host: GitHub
- URL: https://github.com/thibseisel/tomee-webapp-archetype
- Owner: thibseisel
- Created: 2017-04-11T15:11:36.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-05T11:03:46.000Z (over 8 years ago)
- Last Synced: 2025-01-26T04:28:06.898Z (about 1 year ago)
- Topics: angular4, docker, javaee, maven-archetype, tomee
- Language: TypeScript
- Homepage:
- Size: 2.2 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tomee-webapp-archetype
Maven archetype that allows quick creation and deployment of a webapp with a TomEE server and a MySQL database.
In addition to the server-side sample code, this archetype also setups the development environment of an Angular 4.0 front-end project.
# Prerequisites
- Maven
- Docker
- NodeJS v6.9.0 or newer
Note that if you're using Windows, you need to install a virtualization tool such as VirtualBox to run Docker in a Linux virtual machine.
# Using this archetype
Clone this repository and copy this Maven archetype to your local repository, located under __homedir/.m2/repository__.
```
cd tomee-webapp-archetype
mvn install
```
You can now generate a new project using this archetype.
```
mvn archetype:generate -DarchetypeGroupId=fr.nihilus -DarchetypeArtifactId=tomee-webapp-archetype
```
You will be prompted to specify your groupId, artifactId, version and package name.
Before accepting the setup by typing Y, check that the value of the following properties are correct :
- __dbName__ : the name you want to give to your MySQL database
- __dbUser__ : the name of your MySQL user. This will be used by your application to connect via JPA.
- __dbPassword__ : the password for your user.
- __dbRootPassword__ : the password for the _root_ user.
If not, type N and set their value to match your expectations.
Your project is now fully generated !
# Running the generated project
## Windows
Copy the content of the folder _docker/DEV_ of your generated project to your Linux virtual machine.
In order to do that, you can use WinSCP or type the following command in a Git Bash :
```bash
scp -r docker/DEV/* username@localhost:~
```
Where _username_ is the name of your user in virtual machine.
When done, create the MySQL and TomEE docker images with the provided scripts.
```bash
./build-images.sh
./run-images.sh
```
Check that TomEE is working correctly by opening your browser with the following url address : _http://localhost:8080_.
You can now build the Angular part of this sample project and then upload the whole project to the running TomEE container.
Navigate to the root folder of the project and run those commands :
```
cd angular
npm install
npm run build
cd ..
mvn tomcat7:deploy
```
Finally, open a browser at _http://localhost:8080/myapp_, where _myapp_ is the artifactId you gave when generating your project.
If a success message appear, then your project and development environment are now all set !
## Linux
You don't have to install a virtual machine to run Docker.
Navigate to the docker/DEV directory of your generated project., and run the following scripts to create your MySQL and TomEE docker images :
```
./build-images.sh
./run-images.sh
```
Check that TomEE is working correctly by navigating to the following url address : _http://localhost:8080_.
You can now build the Angular part of this sample project and then upload the whole project to the running TomEE container.
Navigate to the root folder of the project and run those commands :
```
cd angular
npm run build
cd ..
mvn tomcat7:deploy
```
Finally, open a browser at _http://localhost:8080/myapp_, where _myapp_ is the artifactId you gave when generating your project.
If a success message appear, then your project and development environment are now all set !
# Generated directory structure
The generated project follows the Maven standard directory structure.
```
.
+-- _angular
+-- _docker
+-- _src
+-- _main
+-- _java
+-- _resources
+-- _webapp
+-- _test
+-- java
```
- The __src/main/java__ folder contains the code for your Java server application
- The __src/main/resources__ folder mainly contains configuration files (in our case, _persistence.xml_)
- The __src/main/webapp__ folder is where you put your HTML and Javascript client code
- The __src/test/java__ folder replicates the src/main/java package structure and contains all unit tests
- The __angular__ folder contains an Angular project generated with [@angular/cli](https://cli.angular.io)
In this project, there's an additional __docker__ folder containing script you used to setup your development environment.
# Sample code
The generated project features an example of a working RESTful application allowing to store and retrieve books.
Note that it only accepts JSON.
You can issue the following requests :
- __GET /api/books__ to get the list of all books from the database,
- __GET /api/books/{id}__ to get a specific book by its id,
- __POST /api/books__ to add a new book to the database (body must feature and object with a property "title"),
- __PUT /api/books/{id}__ to update an existing book (body must feature and object with a property "title"),
- __DELETE /api/books/{id}__ to delete an existing book.
You are free to modify or delete this code to replace it with your own application logic.