Patrick.Sy/spring-petclinic
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-petclinic.git synced 2025-07-15 20:35:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

various updates to the documentation file

Browse source
This commit is contained in:
Mic 2013-03-20 16:13:31 +08:00
parent 6086dec5c3
commit df0d048782
1 changed files with 87 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

97
readme.md
View file

@ -3,6 +3,9 @@
## What does it look like? ## What does it look like?
spring-petclinic has been deployed here on cloudfoundry: http://spring-petclinic.cloudfoundry.com/ spring-petclinic has been deployed here on cloudfoundry: http://spring-petclinic.cloudfoundry.com/
## Understanding the Spring Petclinic application with a few diagrams
<a href="https://speakerdeck.com/michaelisvy/spring-petclinic-sample-application">See the presentation here</a>
## Running petclinic locally ## Running petclinic locally
``` ```
git clone https://github.com/SpringSource/spring-petclinic.git git clone https://github.com/SpringSource/spring-petclinic.git
@ -25,11 +28,11 @@ If m2e is not there, just follow the install process here: http://eclipse.org/m2
### Steps: ### Steps:
In the command line 1) In the command line
``` ```
git clone https://github.com/SpringSource/spring-petclinic.git git clone https://github.com/SpringSource/spring-petclinic.git
``` ```
Inside Eclipse: 2) Inside Eclipse
``` ```
File -> Import -> Maven -> Existing Maven project File -> Import -> Maven -> Existing Maven project
``` ```
@ -39,34 +42,108 @@ File -> Import -> Maven -> Existing Maven project
<table> <table>
<tr> <tr>
<th>Web layer</th><th>Files</th> <th width="300px">Inside the 'Web' layer</th><th width="300px">Files</th>
</tr> </tr>
<tr> <tr>
<td>Spring MVC- Atom integration</td> <td>Spring MVC- Atom integration</td>
<td> <td>
<a href="/SpringSource/spring-petclinic/blob/master/src/main/java/org/springframework/samples/petclinic/web/VisitsAtomView.java">VisitsAtomView</a> <a href="/SpringSource/spring-petclinic/blob/master/src/main/java/org/springframework/samples/petclinic/web/VetsAtomView.java">VetsAtomView.java</a>
<a href="/SpringSource/spring-petclinic/blob/master/src/main/webapp/WEB-INF/mvc-view-config.xml">mvc-view-config.xml</a> <a href="/SpringSource/spring-petclinic/blob/master/src/main/resources/spring/mvc-view-config.xml">mvc-view-config.xml</a>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>Spring MVC - XML integration</td> <td>Spring MVC - XML integration</td>
<td><a href="/SpringSource/spring-petclinic/blob/master/src/main/webapp/WEB-INF/mvc-view-config.xml">mvc-view-config.xml</a></td> <td><a href="/SpringSource/spring-petclinic/blob/master/src/main/resources/spring/mvc-view-config.xml">mvc-view-config.xml</a></td>
</tr>
<tr>
<td>Spring MVC - ContentNegotiatingViewResolver</td>
<td><a href="/SpringSource/spring-petclinic/blob/master/src/main/resources/spring/mvc-view-config.xml">mvc-view-config.xml</a></td>
</tr> </tr>
<tr> <tr>
<td>Spring MVC Test Framework</td> <td>Spring MVC Test Framework</td>
<td><a href="/SpringSource/spring-petclinic/blob/master/src/test/java/org/springframework/samples/petclinic/web/VisitsAtomViewTest.java">VisitsAtomViewTest.java</a></td> <td><a href="/SpringSource/spring-petclinic/blob/master/src/test/java/org/springframework/samples/petclinic/web/VisitsViewTest.java">VisitsViewTest.java</a></td>
</tr> </tr>
<tr> <tr>
<td>JSP custom tags</td> <td>JSP custom tags</td>
<td> <td>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/webapp/WEB-INF/tags">WEB-INF/tags</a></td> <a href="/SpringSource/spring-petclinic/tree/master/src/main/webapp/WEB-INF/tags">WEB-INF/tags</a>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/webapp/WEB-INF/jsp/owners/createOrUpdateOwnerForm.jsp">createOrUpdateOwnerForm.jsp</a></td>
</tr> </tr>
<tr> <tr>
<td>webjars</td> <td>webjars</td>
<td> <td>
<a href="/SpringSource/spring-petclinic/tree/master/pom.xml#L171">webjars declaration inside pom.xml</a> <br /> <a href="/SpringSource/spring-petclinic/tree/master/pom.xml">webjars declaration inside pom.xml</a> <br />
<a href="/SpringSource/spring-petclinic/blob/master/src/main/webapp/WEB-INF/mvc-core-config.xml#L24">Resource mapping in Spring configuration</a> <br /> <a href="/SpringSource/spring-petclinic/blob/master/src/main/resources/spring/mvc-core-config.xml#L24">Resource mapping in Spring configuration</a> <br />
<a href="/SpringSource/spring-petclinic/blob/master/src/main/webapp/WEB-INF/jsp/fragments/headTag.jsp#L12">sample usage in JSP</a></td> <a href="/SpringSource/spring-petclinic/blob/master/src/main/webapp/WEB-INF/jsp/fragments/headTag.jsp#L12">sample usage in JSP</a></td>
</td> </td>
</tr> </tr>
<tr>
<td>Dandelion</td>
<td>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/webapp/WEB-INF/jsp/owners/ownersList.jsp">ownersList.jsp</a>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/webapp/WEB-INF/web.xml">web.xml</a>
</td>
</tr>
<tr>
<td>Thymeleaf branch</td>
<td>
<a href="http://www.thymeleaf.org/petclinic.html">See here</a></td>
</tr>
</table> </table>
<table>
<tr>
<th width="300px">'Service' and 'Repository' layers</th><th width="300px">Files</th>
</tr>
<tr>
<td>Transactions</td>
<td>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/resources/spring/business-config.xml">business-config.xml</a>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/java/org/springframework/samples/petclinic/service/ClinicServiceImpl.java">ClinicServiceImpl.java</a>
</td>
</tr>
<tr>
<td>Cache</td>
<td>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/resources/spring/tools-config.xml">tools-config.xml</a>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/java/org/springframework/samples/petclinic/service/ClinicServiceImpl.java">ClinicServiceImpl.java</a>
</td>
</tr>
<tr>
<td>Bean Profiles</td>
<td>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/resources/spring/business-config.xml">business-config.xml</a>
<a href="/SpringSource/spring-petclinic/tree/master/src/test/java/org/springframework/samples/petclinic/service/ClinicServiceJdbcTests.java">ClinicServiceJdbcTests.java</a>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/webapp/WEB-INF/web.xml">web.xml</a>
</td>
</tr>
<tr>
<td>JdbcTemplate</td>
<td>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/resources/spring/business-config.xml">business-config.xml</a>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/java/org/springframework/samples/petclinic/repository/jdbc">jdbc folder</a></td>
</tr>
<tr>
<td>JPA</td>
<td>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/resources/spring/business-config.xml">business-config.xml</a>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/java/org/springframework/samples/petclinic/repository/jpa">jpa folder</a></td>
</tr>
<tr>
<td>Spring Data JPA</td>
<td>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/resources/spring/business-config.xml">business-config.xml</a>
<a href="/SpringSource/spring-petclinic/tree/master/src/main/java/org/springframework/samples/petclinic/repository/springdatajpa">springdatajpa folder</a></td>
</tr>
</table>
<table>
<tr>
<th width="300px">Others</th><th width="300px">Files</th>
</tr>
<tr>
<td>Gradle branch</td>
<td>
<a href="https://github.com/whimet/spring-petclinic">See here</a></td>
</tr>
</table>