React Frontend for Spring Boot PetClinic demo
I have tried to make as few modifications to the backend code as necessary to the spring-boot branch of the original sample project.
Mainly I've added the new package
that contains the REST Api that is used by the React frontend. In this package most of the classes are taken
from the angularjs version of the demo.
Note there is another Spring PetClinic example that uses React: spring-petclinic-graphql. Beside React that example uses GraphQL for API queries instead of the REST API.
If you like to help and contribute (there's lot root for improvements! I've collected a list of ideas here: TODO.md) you're more than welcome! Please open an issue or contact me on Twitter so we can discuss together!
Install and run
Note: Spring Boot Server App must be running before starting the client!
To start the server, launch a Terminal and run from the project's root folder (
When the server is running you can try to access the API for example to query all known pet types:
After starting the server you can install and run the client from the
npm install(installs the node modules and the TypeScript definition files)
PORT=4444 npm start
In case you have any comments, questions, bugs, enhancements feel free to open an issue in this repository. If you you want to follow me on twitter, my handle is @nilshartmann.
From the original sample README file:
Understanding the Spring Petclinic application with a few diagrams
Running petclinic locally
git clone https://github.com/spring-projects/spring-petclinic.git cd spring-petclinic git checkout springboot ./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-projects/spring-petclinic/issues
In its default configuration, Petclinic uses an in-memory database (HSQLDB) which 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:
docker run -e MYSQL_ROOT_PASSWORD=petclinic -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:5.7.8
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
Looking for something in particular?
|Spring Boot Configuration|
|The Main Class||PetClinicApplication.java|
|Caching||Use of EhCache CacheConfig.java ehcache.xml|
|Dandelion||DatatablesFilter, DandelionFilter and DandelionServlet registration DandelionConfig.java|
|Spring MVC - XML integration||CustomViewsConfiguration.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:
|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|
The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.