mirror of
https://github.com/apache/struts.git
synced 2026-08-05 14:47:09 +00:00
WW-4440 Adds basic README.md to all submodules
This commit is contained in:
Lukasz Lenart
@@ -0,0 +1,12 @@
|
||||
# Struts 2 Apps
|
||||
These module consists of two example applications, which were built using the Apache Struts project.
|
||||
One is an old-fashioned Web application and another is a modern REST based single page app.
|
||||
|
||||
## Installation
|
||||
Enter a given folder, either `showcase/` or `rest-showcase/` and start the app using Maven:
|
||||
|
||||
```
|
||||
mvn jetty:run
|
||||
```
|
||||
|
||||
then open your browser at http://localhost:8080 and navigate to a proper context.
|
||||
@@ -0,0 +1,3 @@
|
||||
# Struts 2 Assemblies
|
||||
This module is used to prepare ZIP archives with different set of JARs, like code source, Javadocs, etc.
|
||||
It's a part of the release process, it shouldn't be used directly by users.
|
||||
@@ -0,0 +1,20 @@
|
||||
# Struts 2 BOM
|
||||
This is a Bill-Of-Materials to be used with Maven based project. It allows to import all the Struts 2
|
||||
dependencies at once and used them in your project where needed.
|
||||
|
||||
## Installation
|
||||
You must add a proper import statement into your `pom.xml` as presented below:
|
||||
|
||||
```xml
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.apache.struts</groupId>
|
||||
<artifactId>struts2-bom</artifactId>
|
||||
<version>${struts2.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</dependencyManagement>
|
||||
```
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Core
|
||||
This is a core of the Apache Struts framework and all other modules depend on it.
|
||||
It requires Java 8 at minimum and a Servlet container supporting Java Servlet API 3.1 at least.
|
||||
|
||||
## Installation
|
||||
Just drop this plugin into `WEB-INF/lib` folder or add it as Maven dependency
|
||||
@@ -0,0 +1,3 @@
|
||||
# Struts 2 Plugins
|
||||
A set of officially supported plugins which are provided with the framework, you can read more about them
|
||||
in the [documentation](https://struts.apache.org/plugins/).
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Async plugin
|
||||
This plugin add support for async actions which can be used since Servlet API 3.0
|
||||
(lack of documentation!!!)
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency
|
||||
@@ -0,0 +1,7 @@
|
||||
# Struts 2 Bean Validation plugin
|
||||
This plugin add support for using the Bean Validation API instead of the built-in native Struts 2 validation logic.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/bean-validation/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency. You must also provide
|
||||
a proper implementation of the Bean Validation API, eg.: [Hibernate Bean Validation](https://hibernate.org/validator/)
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 CDI plugin
|
||||
This plugin add support for using the Contexts and Dependency Injection (CDI) API with your Struts actions.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/cdi/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Config Browser plugin
|
||||
This plugin allows to browse configuration of Struts in your application. **It shouldn't be used in production**!
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/config-browser/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Convention plugin
|
||||
This plugin allows to use _convention over configuration_ approach instead of configuring everything using `struts.xml`.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/convention/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Direct Web Remoting (DWR) plugin
|
||||
This plugin allows to use Struts validation via DWR as remote beans.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/dwr/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 EmbeddedJSP plugin
|
||||
This plugin is deprecated and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 GXP plugin
|
||||
This plugin is deprecated and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Direct Web Remoting (DWR) plugin
|
||||
This plugin allows to use Jasper reports as a one of the result types.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/jasperreports/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Java Templates plugin
|
||||
This plugin provides a faster Java implementation of tags in the `simple` theme.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/javatemplates/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 JFreeChart plugin
|
||||
The JFreeChart plugin allows Actions to easily return generated charts and graphs.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/jfreechart/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 JFreeChart plugin
|
||||
The JSON plugin provides a json result type that serializes actions into JSON.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/json/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,7 @@
|
||||
# Struts 2 JFreeChart plugin
|
||||
The JUnit Plugin supports testing actions within a Struts invocation, meaning that a full request is simulated,
|
||||
and the output of the action can be tested.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/junit/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 OSGi plugin
|
||||
This plugin is deprecated and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 OVal plugin
|
||||
This plugin is deprecated and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 Pell Multipart plugin
|
||||
This plugin is deprecated and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 Plexus plugin
|
||||
This plugin is deprecated and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 Portlet Mocks plugin
|
||||
This plugin is deprecated, and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 Portlet Tiles plugin
|
||||
This plugin is deprecated, and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 Portlet plugin
|
||||
This plugin is deprecated, and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,7 @@
|
||||
# Struts 2 REST plugin
|
||||
The REST Plugin provides high level support for the implementation of RESTful resource based web applications
|
||||
with the Convention Plugin.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/rest/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,2 @@
|
||||
# Struts 2 Sitemesh plugin
|
||||
This plugin is deprecated, and it will be removed soon, **please do not use it**!
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Spring plugin
|
||||
The Spring Plugin works by overriding the Struts ObjectFactory to enhance the creation of core framework objects
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/spring/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 TestNG plugin
|
||||
The TestNG plugin provides integration with the popular TestNG unit testing framework.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/testng/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Tiles plugin
|
||||
The Tiles plugin allows actions to return Tiles pages.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/tiles/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
@@ -0,0 +1,6 @@
|
||||
# Struts 2 Velocity plugin
|
||||
The Tiles plugin allows actions to return Tiles pages.
|
||||
You will find more details in [documentation](https://struts.apache.org/plugins/velocity/).
|
||||
|
||||
## Installation
|
||||
Just drop this plugin JAR into `WEB-INF/lib` folder or add it as a Maven dependency.
|
||||
Reference in New Issue
Block a user