Webapps Commons

Project containing a bunch of commons stuff that can be used for building web applications.

Java 11 is required for this library to be used

Description

This project contains a bunch of libraries defining and implementing stuff that can be used for building web applications.

How to use it?

Get it!

Maven Central

All the modules are hosted in Maven Central, and can be accessed by adding the corresponding dependency in your pom.xml file.

For example:

<dependency>
    <groupId>com.bellotapps.webapps</groupId>
    <artifactId>webapps-commons-authentication</artifactId>
    <version>${webapps-commons.version}</version>
</dependency>

Build from source

You can also build your own versions of the libraries. Maven is required for this.

$ git clone https://github.com/bellotapps/webapps-commons.git
$ cd webapps-commons
$ mvn clean install

Note: There are several profiles defined in the root's pom.xml file. The local-deploy profile will also install the sources and javadoc jars. You can use it like this:

$ mvn clean install -P local-deploy

Note: You can also download the source code from https://github.com/bellotapps/webapps-commons/archive/master.zip

Note: If you just want to get the JAR files, you must use the following command which won't install the libraries in your local repository.

$ mvn clean package

Bill of Materials

This project includes a Bill Of Materials in order to make it easier to import the libraries. Include the following in your pom.xml.

<dependencyManagement>
    <dependencies>
        <!-- ... -->
        <dependency>
            <groupId>com.bellotapps.webapps</groupId>
            <artifactId>webapps-commons-bom</artifactId>
            <version>${webapps-commons.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <!-- ... -->
    </dependencies>
</dependencyManagement>

After adding the webapps-commons-bom artifact as an imported managed dependency, you can start using the different libraries in your project.

Dependencies module

This project includes a module defining a set of dependencies that might be used by users of these libraries. It is also used by the rest of the modules in this project.

To use this module, include the following in your pom.xml.

<dependencyManagement>
    <dependencies>
        <!-- ... -->
        <dependency>
            <groupId>com.bellotapps.webapps</groupId>
            <artifactId>webapps-commons-dependencies</artifactId>
            <version>${webapps-commons.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <!-- ... -->
    </dependencies>
</dependencyManagement>

After adding the webapps-commons-dependencies artifact as an imported managed dependency, you can start using the different dependencies that are used in these libraries.

Parent project

If you want to make it simpler, you can make your project extend the webapps-commmons-parent-project Maven Project. If you do so, you woon't have to add the webapps-commons-bom and the webapps-commons-dependencies modules as imported managed dependencies, as they are already imported in the parent project.

Another feature that this parent project includes is the management of several plugins that might help your own build, including the spring-boot-maven-plugin, using the same version as the spring-boot artifacts.

To use the parent project, modify your pom.xml file to include the following:

<parent>
    <groupId>com.bellotapps.webapps</groupId>
    <artifactId>webapps-commons-parent-project</artifactId>
    <version>${webapps-commons.version}</version>
</parent>

Note: A placeholder is used as version in the previous example to avoid changing it each time a new version is released. Replace the ${webapps-commons.version} placeholder with the actual version of the webapps-commons project.

Development

This instructions will set up the development environment in your local machine.

Prerequisites

1. Clone the repository, or download source code:

   $ git clone https://github.com/bellotapps/webapps-commons.git
   

   or

   $ wget https://github.com/bellotapps/webapps-commons/archive/master.zip
   

2. Install Maven

   Note: Maven 3.5+ is required!

   Mac OS X

   $ brew install maven
   

   Ubuntu

   $ sudo apt-get install maven
   

   Other OSes

   Check https://maven.apache.org/install.html.

Build

1. Change working directory to project root

   $ cd <project-root>
   

2. Build artifacts

   $ mvn clean package
   

License

Copyright 2018-2019 BellotApps

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.