Understanding the Spring Petclinic application with a few diagrams
Running petclinic locally
git clone https://github.com/spring-petclinic/spring-petclinic-angularjs.git cd spring-petclinic-angularjs ./mvnw clean install cd spring-petclinic-server ../mvnw spring-boot:run
You can then access petclinic here: http://localhost:8080/
In case you find a bug/suggested improvement for Spring Petclinic
Our issue tracker is available here: https://github.com/spring-petclinic/spring-petclinic-angularjs/issues
In its default configuration, Petclinic uses an in-memory database (HSQLDB) which gets populated at startup with data. A similar setups is provided for MySql in case a persistent database configuration is needed. To run petclinic locally using MySQL database, it is needed to change profile defined in the application.properties` file.
For MySQL database, it is needed to switch profile. There is two ways:
- Update application properties: open the
application.propertiesfile, then change the value
- Use a Spring Boot JVM parameter: simply start the JVM with the
Before do this, it would be good to change JDBC url properties defined in the
spring.datasource.url = jdbc:mysql://localhost:3306/petclinic?useUnicode=true spring.datasource.username=root spring.datasource.password=petclinic
localhost host should be set for a MySQL dabase instance started on your local machine.
You may also start a MySql database with docker:
docker run --name mysql-petclinic -e MYSQL_ROOT_PASSWORD=petclinic -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:5.7
Run an image
To run a Docker image of Petclinic with its embedded HSQL database, you may
docker run -p 8080:8080 -t --name springboot-petclinic arey/springboot-petclinic
If you want to use MySQL, you first have to change the
spring.datasource.url declared in the
You have to rebuild the image (see next section).
Then you could activated the
docker run -e "SPRING_PROFILES_ACTIVE=mysql,prod" -p 8080:8080 -t --name springboot-petclinic arey/springboot-petclinic
Use Docker Compose
The simplest way is to use docker-compose
Build an image
To rebuild a Docker image on your device:
./mvnw clean install cd spring-petclinic-server mvn clean package docker:build
To publish a new image into Docker Hub:
mvn clean package docker:build -DpushImageTag
Working with Petclinic in Eclipse/STS
The following items should be installed in your system:
- Maven 3 (http://www.sonatype.com/books/mvnref-book/reference/installation.html)
- git command line tool (https://help.github.com/articles/set-up-git)
- Eclipse with the m2e plugin (m2e is installed by default when using the STS (http://www.springsource.org/sts) distribution of Eclipse)
Note: when m2e is available, there is an m2 icon in Help -> About dialog. If m2e is not there, just follow the install process here: http://eclipse.org/m2e/download/
- In the command line
git clone https://github.com/spring-projects/spring-petclinic.git
- Inside Eclipse
File -> Import -> Maven -> Existing Maven project
Active the dev Spring profile
In development mode, we recommand you yo use the
dev Spring profile.
Just add the following VM option:
All static resources changes will be monitored by the embedded LiveReload server of Spring Boot Devtools. See application-dev.properties for details.
Compared to the standard Petclinic based on JSP pages, this SpringBoot AngularJS Petclinic is splitted in 2 modules - a client module and a server module:
- spring-petclinic-client : static resources (images, fonts, style, angular JS code) packaged as a webjar.
- spring-petclinic-server : Spring MVC REST API and an index.html template
Looking for something in particular?
|Spring Boot Configuration||Files|
|The Main Class||PetClinicApplication.java|
|Common properties file||application.properties|
|Development properties file||application-dev.properties|
|Production properties file||application-prod.properties|
|Caching: Cache with EhCache||CacheConfig.java|
|Homepage||Map root context to the index.html template: WebConfig.java|
Interesting Spring Petclinic forks
The Spring Petclinic master branch in the main spring-projects GitHub org is the "canonical" implementation, currently based on Spring Boot and Thymeleaf.
This [spring-petclinic-angularjs] project is one of the several forks hosted in a special GitHub org: spring-petclinic. If you have a special interest in a different technology stack that could be used to implement the Pet Clinic then please join the community there.
The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.