https://github.com/bmuschko/todo-spring-boot

A sample To Do web application built with Gradle and Spring Boot.
https://github.com/bmuschko/todo-spring-boot

Last synced: 7 days ago
JSON representation

A sample To Do web application built with Gradle and Spring Boot.

• Host: GitHub
• URL: https://github.com/bmuschko/todo-spring-boot
• Owner: bmuschko
• Created: 2016-06-20T12:19:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-26T15:21:18.000Z (8 months ago)
• Last Synced: 2024-03-26T16:37:36.392Z (8 months ago)
• Language: Java
• Size: 107 KB
• Stars: 18
• Watchers: 4
• Forks: 92
• Open Issues: 0
• Metadata Files:
  • Readme: README.asciidoc

Awesome Lists containing this project

README

        
= A sample To Do web application image:https://travis-ci.org/bmuschko/todo-spring-boot.svg?branch=master["Build Status", link="https://travis-ci.org/bmuschko/todo-spring-boot"]

This project is a simple, MVC-based task management web application written in Java powered by Spring Boot. Its main purpose is to demonstrate implementation approaches for typical project automation requirements with the help of Gradle. The code of this project is featured in the book link:http://www.manning.com/muschko["Gradle in Action"] published by Manning.

== Applied Gradle features

* Usage of the Gradle Wrapper.

* Support for a multi-project build.

* Implements various testing strategies:

** Unit testing with Spock.

** Integration testing Spring test utilities.

* Static code analysis with publishing of result to SonarCloud.

* Deployment of the WAR file to Heroku.

== Build pipeline

The project includes a Jenkins pipeline definition file named `Jenkinsfile`. The pipeline consists of the following steps:

1. **Compile source code:** Executes the Java compiler to turn production and test source code into byte code.

2. **Execute unit tests:** Runs the unit test suite for fast feedback.

3. **Execute integration tests:** Performs long-running integration tests.

4. **Perform static code analysis:** Analyzes the source code and identifies quality hotspots. For convenience reasons, the project uses the cloud-based service of Sonarqube.

6. **Assemble the WAR file:** Builds the final deliverable, a WAR file containing all resources needed in the runtime environment.

7. **Deploy the deliverable to production:** Pushes the WAR file to the Paas, Heroku, upon request.

== Running the application

You can directly run your application your local machine. There's no need to install a Servlet container. In a terminal window execute the following command from the root level of the project:

*Mac OS X/*nix*

[source]

----

./gradlew bootRun

----

*Windows*

[source]

----

gradlew.bat bootRun

----

Open your browser of choice and navigate to the URL `http://localhost:8080/`.