From 9c11c701632d174cdffd43ab17cd1bbbea8961dd Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Fri, 11 Nov 2016 09:29:01 +0000 Subject: [PATCH] Update readme for Spring Boot fetaures --- readme.md | 91 ++++++++----------------------------------------------- 1 file changed, 12 insertions(+), 79 deletions(-) diff --git a/readme.md b/readme.md index d0ad14f94..fdc5491b0 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# 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 See the presentation here @@ -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? - - - - - - - - - - - - - - - - - - - - -
Spring Boot Configuration
The Main ClassPetClinicApplication.java
Properties Files - application.properties -
CachingUse of EhCache CacheConfig.java ehcache.xml
Spring MVC - XML integrationCustomViewsConfiguration.java
- - - - - - - - - - - - - - - -
OthersFiles
JSP custom tags - WEB-INF/tags - createOrUpdateOwnerForm.jsp
Bower - bower-install maven profile declaration inside pom.xml
- JavaScript libraries are defined by the manifest file bower.json
- Bower configuration using JSON
- Resource mapping in Spring configuration
- sample usage in JSP
- +|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: - - - - - - - - - - - - - - - - - - - - - - -
Name Issue
Spring JDBC: simplify usage of NamedParameterJdbcTemplate SPR-10256 and SPR-10257
Bean Validation / Hibernate Validator: simplify Maven dependencies and backward compatibility - HV-790 and HV-792 -
Spring Data: provide more flexibility when working with JPQL queries - DATAJPA-292 -
Eclipse: validation bug when working with .tag/.tagx files (has only been fixed for Eclipse 4.3 (Kepler)). See here for more details. - STS-3294 -
+| 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