Skip to content
Snippets Groups Projects
Commit 767bc826 authored by Antoine Rey's avatar Antoine Rey
Browse files

Remove deprecated Eclipse documentation and convert HTML table to Markdown syntax

parent 4af48473
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 18 additions and 120 deletions
README.md
+ 18
− 120
View file @ 767bc826
......@@ -22,7 +22,8 @@ You can then access petclinic here: http://localhost:8080/
<img width="782" alt="springboot-petclinic" src="https://cloud.githubusercontent.com/assets/838318/19653851/61c1986a-9a16-11e6-8b94-03fd7f775bb3.png">
## In case you find a bug/suggested improvement for Spring Petclinic
## In case you find a bug/suggested improvement for Spring Petclinic Microservices
Our issue tracker is available here: https://github.com/spring-petclinic/spring-petclinic-microservices/issues
## Database configuration
......@@ -37,131 +38,28 @@ You may start a MySql database with docker:
docker run -e MYSQL_ROOT_PASSWORD=petclinic -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:5.7.8
```
## Working with Petclinic in Eclipse/STS
### prerequisites
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/
### Steps:
1) In the command line
```
git clone https://github.com/spring-petclinic/spring-petclinic-microservices.git
```
2) Inside Eclipse
```
File -> Import -> Maven -> Existing Maven project
```
## Client-side Architecture
[TBD]
Compared to the [standard Petclinic based on JSP pages](https://github.com/spring-projects/spring-petclinic),
this ~~SpringBoot AngularJS Petclinic is splitted in 2 modules - a client module and a server module~~:
* springboot-petclinic-client : static resources (images, fonts, style, angular JS code) packaged as a webjar.
* ~~springboot-petclinic-server : Spring MVC REST API and an index.html template~~
## Looking for something in particular?
| Spring Cloud components | Resources |
|-------------------------|------------|
| Configuration server | [Config server properties](spring-petclinic-config-server/src/main/resources/application.yml) and [Configuration repository](https://github.com/spring-petclinic/spring-petclinic-microservices-config) |
| Service Discovery | [Eureka server](spring-petclinic-discovery-server) and [Service discovery client](spring-petclinic-vets-service/src/main/java/org/springframework/samples/petclinic/vets/VetsServiceApplication.java) |
| API Gateway | [Zuul reverse proxy](spring-petclinic-api-gateway/src/main/java/org/springframework/samples/petclinic/api/ApiGatewayApplication.java) and [Routing configuration](https://github.com/spring-petclinic/spring-petclinic-microservices-config/blob/master/api-gateway.yml) |
| Docker Compose | [Spring Boot with Docker guide](https://spring.io/guides/gs/spring-boot-docker/) and [docker-compose file](docker-compose.yml) |
| Circuit Breaker | TBD |
| Graphite Monitoring | TBD |
## Looking for something in particular?
Front-end module | Files |
|-------------------|-------|
| Node and NPM | [The frontend-maven-plugin plugin downloads/installs Node and NPM locally then runs Bower and Gulp](spring-petclinic-ui/pom.xml) |
| Bower | [JavaScript libraries are defined by the manifest file bower.json](spring-petclinic-ui/bower.json) |
| Gulp | [Tasks automated by Gulp: minify CSS and JS, generate CSS from LESS, copy other static resources](spring-petclinic-ui/gulpfile.js) |
| Angular JS | [app.js, controllers and templates](spring-petclinic-ui/src/scripts/) |
<table>
<tr>
<th width="300px">Spring Cloud components</th><th width="300px"></th>
</tr>
<tr>
<td>Configuration server</td>
<td><a href="https://github.com/spring-petclinic/spring-petclinic-microservices/blob/master/spring-petclinic-config-server/src/main/resources/application.yml">Config server properties</a>,
<a href="https://github.com/spring-petclinic/spring-petclinic-microservices-config">Configuration repository</a></td>
</tr>
<tr>
<td>Service discovery</td>
<td>
<a href="https://github.com/spring-petclinic/spring-petclinic-microservices/tree/master/spring-petclinic-discovery-server">Eureka server</a>,
<a href="https://github.com/spring-petclinic/spring-petclinic-microservices/blob/master/spring-petclinic-vets-service/src/main/java/org/springframework/samples/petclinic/vets/VetsServiceApplication.java">Service discovery client</a>
</td>
</tr>
<tr>
<td>API gateway</td>
<td><a href="https://github.com/spring-petclinic/spring-petclinic-microservices/blob/master/spring-petclinic-api-gateway/src/main/java/org/springframework/samples/petclinic/api/ApiGatewayApplication.java">Zuul reverse proxy</a>,
<a href="https://github.com/spring-petclinic/spring-petclinic-microservices-config/blob/master/api-gateway.yml">Routing configuration</a></td>
</tr>
<tr>
<td>Circuit breaker</td>
<td>TBD</td>
</tr>
<tr>
<td>Graphite monitoring</td>
<td>TBD</td>
</tr>
</table>
<table>
<tr>
<th width="300px">Front-end module</th><th width="300px">Files</th>
</tr>
<tr>
<td>Node and NPM</td>
<td>
<a href="https://github.com/spring-petclinic/spring-petclinic-microservices/blob/master/spring-petclinic-client/pom.xml">The frontend-maven-plugin plugin downloads/installs Node and NPM locally then runs Bower and Gulp</a>
</td>
</tr>
<tr>
<td>Bower</td>
<td>
<a href="https://github.com/spring-petclinic/spring-petclinic-microservices/blob/master/spring-petclinic-client/bower.json">JavaScript libraries are defined by the manifest file bower.json</a>
</td>
</tr>
<tr>
<td>Gulp</td>
<td>
<a href="https://github.com/spring-petclinic/spring-petclinic-microservices/blob/master/spring-petclinic-client/gulpfile.js">Tasks automated by Gulp: minify CSS and JS, generate CSS from LESS, copy other static resources</a>
</td>
</tr>
<tr>
<td>AngularJS</td>
<td>
<a href="https://github.com/spring-petclinic/spring-petclinic-microservices/blob/master/spring-petclinic-client/src/scripts/app.js">Application module</a>,
<a href="https://github.com/toddmotto/angular-1-5-components-app">Angular 1.5 component architecture</a>
</td>
</tr>
</table>
## 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>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>
</table>
# Contributing
The [issue tracker](https://github.com/spring-petclinic/spring-petclinic-microservices/issues) is the preferred channel for bug reports, features requests and submitting pull requests.
For pull requests, editor preferences are available in the [editor config](https://github.com/spring-projects/spring-petclinic/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
For pull requests, editor preferences are available in the [editor config](.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
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