Skip to content
Snippets Groups Projects
Commit 9c11c701 authored by Dave Syer's avatar Dave Syer
Browse files

Update readme for Spring Boot fetaures

parent 095b1a35
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 12 additions and 79 deletions
readme.md
+ 12
− 79
View file @ 9c11c701
# Spring Boot version of the Spring PetClinic Sample Application [![Build Status](https://travis-ci.org/spring-projects/spring-petclinic.png?branch=master)](https://travis-ci.org/spring-projects/spring-petclinic/)
# Spring PetClinic Sample Application [![Build Status](https://travis-ci.org/spring-projects/spring-petclinic.png?branch=master)](https://travis-ci.org/spring-projects/spring-petclinic/)
## Understanding the Spring Petclinic application with a few diagrams
<a href="https://speakerdeck.com/michaelisvy/spring-petclinic-sample-application">See the presentation here</a>
......@@ -7,7 +7,6 @@
```
git clone https://github.com/spring-projects/spring-petclinic.git
cd spring-petclinic
git checkout springboot
./mvnw spring-boot:run
```
......@@ -23,7 +22,7 @@ In its default configuration, Petclinic uses an in-memory database (HSQLDB) whic
gets populated at startup with data. A similar setup is provided for MySql in case a persistent database configuration is needed.
Note that whenever the database type is changed, the data-access.properties file needs to be updated and the mysql-connector-java artifact from the pom.xml needs to be uncommented.
You may start a MySql database with docker:
You could start a MySql database with docker:
```
docker run -e MYSQL_ROOT_PASSWORD=petclinic -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:5.7.8
......@@ -55,88 +54,22 @@ File -> Import -> Maven -> Existing Maven project
## Looking for something in particular?
<table>
<tr>
<th width="300px">Spring Boot Configuration</th><th width="300px"></th>
</tr>
<tr>
<td>The Main Class</td>
<td><a href="/src/main/java/org/springframework/samples/petclinic/application/PetClinicApplication.java">PetClinicApplication.java</a></td>
</tr>
<tr>
<td>Properties Files</td>
<td>
<a href="/src/main/resources/application.properties">application.properties</a>
</td>
</tr>
<tr>
<td>Caching</td>
<td>Use of EhCache <a href="/src/main/java/org/springframework/samples/petclinic/config/CacheConfig.java">CacheConfig.java</a> <a href="/src/main/resources/ehcache.xml">ehcache.xml</a></td>
</tr>
<tr>
<td>Spring MVC - XML integration</td>
<td><a href="/src/main/java/org/springframework/samples/petclinic/config/CustomViewsConfiguration.java">CustomViewsConfiguration.java</a></td>
</tr>
</table>
<table>
<tr>
<th width="300px">Others</th><th width="300px">Files</th>
</tr>
<tr>
<td>JSP custom tags</td>
<td>
<a href="/src/main/webapp/WEB-INF/tags">WEB-INF/tags</a>
<a href="/src/main/webapp/WEB-INF/jsp/owners/createOrUpdateOwnerForm.jsp">createOrUpdateOwnerForm.jsp</a></td>
</tr>
<tr>
<td>Bower</td>
<td>
<a href="/pom.xml">bower-install maven profile declaration inside pom.xml</a> <br />
<a href="/bower.json">JavaScript libraries are defined by the manifest file bower.json</a> <br />
<a href="/.bowerrc">Bower configuration using JSON</a> <br />
<a href="/src/main/resources/spring/mvc-core-config.xml#L30">Resource mapping in Spring configuration</a> <br />
<a href="/src/main/webapp/WEB-INF/jsp/fragments/staticFiles.jsp#L12">sample usage in JSP</a></td>
</td>
</tr>
</table>
|Spring Boot Configuration ||
|--------------------------|-|
|The Main Class | [PetClinicApplication](https://github.com/spring-projects/spring-petclinic/blob/master/src/main/java/org/springframework/samples/petclinic/PetClinicApplication.java) |
|Properties Files | [application.properties](https://github.com/spring-projects/spring-petclinic/blob/master/src/main/resources) |
|Caching | EhCache [CacheConfig](https://github.com/spring-projects/spring-petclinic/blob/master/src/main/java/org/springframework/samples/petclinic/config/CacheConfig.java) |
## Interaction with other open source projects
One of the best parts about working on the Spring Petclinic application is that we have the opportunity to work in direct contact with many Open Source projects. We found some bugs/suggested improvements on various topics such as Spring, Spring Data, Bean Validation and even Eclipse! In many cases, they've been fixed/implemented in just a few days.
Here is a list of them:
<table>
<tr>
<th width="300px">Name</th>
<th width="300px"> Issue </th>
</tr>
<tr>
<td>Spring JDBC: simplify usage of NamedParameterJdbcTemplate</td>
<td> <a href="https://jira.springsource.org/browse/SPR-10256"> SPR-10256</a> and <a href="https://jira.springsource.org/browse/SPR-10257"> SPR-10257</a> </td>
</tr>
<tr>
<td>Bean Validation / Hibernate Validator: simplify Maven dependencies and backward compatibility</td>
<td>
<a href="https://hibernate.atlassian.net/browse/HV-790"> HV-790</a> and <a href="https://hibernate.atlassian.net/browse/HV-792"> HV-792</a>
</td>
</tr>
<tr>
<td>Spring Data: provide more flexibility when working with JPQL queries</td>
<td>
<a href="https://jira.springsource.org/browse/DATAJPA-292"> DATAJPA-292</a>
</td>
</tr>
<tr>
<td>Eclipse: validation bug when working with .tag/.tagx files (has only been fixed for Eclipse 4.3 (Kepler)). <a href="https://github.com/spring-projects/spring-petclinic/issues/14">See here for more details.</a></td>
<td>
<a href="https://issuetracker.springsource.com/browse/STS-3294"> STS-3294</a>
</td>
</tr>
</table>
| Name | Issue |
|------|-------|
| Spring JDBC: simplify usage of NamedParameterJdbcTemplate | [SPR-10256](https://jira.springsource.org/browse/SPR-10256) and [SPR-10257](https://jira.springsource.org/browse/SPR-10257) |
| Bean Validation / Hibernate Validator: simplify Maven dependencies and backward compatibility |[HV-790](https://hibernate.atlassian.net/browse/HV-790) and [HV-792](https://hibernate.atlassian.net/browse/HV-792) |
| Spring Data: provide more flexibility when working with JPQL queries | [DATAJPA-292](https://jira.springsource.org/browse/DATAJPA-292) |
# Contributing
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment