DISID and VMware have ended active development of this project. This repository will no longer be updated.
Spring Roo
Getting started with Spring Roo development :page-layout: base :toc-placement: manual :Author: DISID Corporation S.L. :Email: <[email protected]>
Spring Roo is an easy-to-use development tool for quickly building Spring-powered applications.
Our primary goals are:
-
Build Spring-powered applications in a best-practice manner within minutes.
To develop Spring projects requires incredibly long cycle times yet, yes Spring Boot provide a radically faster and widely accessible getting started experience plus non-functional features for all Spring development and due that Spring Roo generates Spring Boot applications, but even so for midsize applications you need functional features, patterns and best-practices that Spring Roo provides you automatically.
-
Incremental approach to add technologies as needed to your project.
This means when you first start a new project Roo will only assume you want to build a simple Spring Boot application. As such it will have next to no dependencies. Only when you ask to add a persistence provider will JPA be installed, and only when you add a field using JavaBean Validation annotations will that library be installed. The same holds true for Spring Security, Spring Data and the other technologies Roo supports.
-
Use Roo over the full lifespan of a project.
This is particularly important given the long-term maintenance costs of a project far outweigh the initial development costs. While you can use Roo just for an initial jump-start if you so wish, your return on investment is exponential as you continue using it throughout a project lifespan.
Code of Conduct
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Installation and Getting Started
The reference documentation includes detailed descriptions of all the features, detailed installation instructions as well as an extensive user guide for main use cases.
Getting Support
If you have any trouble using Spring Roo:
-
Check the reference documentation.
-
Spring Roo creates web applications based on Spring projects, take a look at the related Spring project reference documentation. In the Spring web-site you will find a lot of excellent reference documentation and getting started guides of the Spring projects.
-
Ask a question in stackoverflow tagged with spring-roo.
Commercial support is available too.
Contribute
Here are some ways for you to get involved in the community:
-
Get involved with the Spring community by helping out on stackoverflow. Join to debates and respond to questions.
-
Report bugs and request new features via the Spring Roo JIRA. Comment and vote on the ones that you are interested in.
-
If you want to write code, you are welcome. Commit your pull requests from forks of this repository.
See the contributor guidelines for details.
Building from Source
The Spring Roo project uses a Maven-based build system.
Spring Roo can be easily built with the maven wrapper from the root of the source tree and serves as a cross-platform, self-contained bootstrap mechanism for the build:
$ ./mvnw clean installSee the contributor guidelines for details.
Staying in Touch
Follow @SpringRoo and its team members on Twitter. In-depth articles can be found at The DISID Blog, and releases are announced via The Spring Blog.
Acknowledgments
The Spring Roo project uses and depends on a lot of Spring related projects, as well as other ones. We would like to thank all those projects and the people working on them, not only for the effort made to provide such excellent libraries and utilities, but also for the guidance and examples given on how to manage an open source Java project.
Also, this README.adoc file has been written based on the ones included in several Spring projects like Spring Boot project and Spring Data JPA.
License
Spring Roo is Open Source software released under the Apache 2.0 license.