tree: 53219d7251a6c45786aa593a8ee4b289395d80aa [path history] [tgz]
  1. .gitignore
  2. .project
  3. LICENSE
  4. NOTICE
  5. README.md
  6. pom.xml
  7. src/
README.md

turbine-webapp-5.0

Maven Archetype to generate a webapp utilizing Turbine 5.0

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Host system installation

  • Java 8 JDK or later
  • MySQl - Database Server
  • Maven - Dependency Management

You should have Java 8 or later installed. The archetype sets up a new application using MySQL as the default database store. However, you can adjust this to use any database supported by Apache Torque 4.0. Therefore, you should be at least have a database instance where you have access rights to create a new database schema and populate it with the tables the application generates. Finally, this is a maven archetype, so of course you should install a local version of Maven (tested with 3.5.4).

Docker (alpha/experimental)

Use docker to rapidly start development without Mysql installing on your local machine. It requires Java 8 and Maven in the hosting system (see above) and additionally

  • Docker version > 17 (Docker-Desktopm Windows)

To install the Docker Archetype into the local repository, run

  • Run mvn clean install -Pdocker

Installing

Eclipse integration:

You need to first add the Apache maven archetypes to your IDE so that you can take advantage of using the turbine-webapp-5.0 plugin to generate a new web application.

The location of the remote catalog file is: http://repo.maven.apache.org/maven2/archetype-catalog.xml

Step-by-step instructions on how to accomplish this can be found here: https://howtodoinjava.com/eclipse/how-to-import-maven-remote-archetype-catalogs-in-eclipse/

Built With

  • Maven - Dependency Management

Contributing

Please feel free to contribute. We are always happy to encourage new committers to the project.

Authors

  • Georg Kallidis
  • Jeffery Painter - Jivecast

License

This project is licensed under the Apache Software License 2.0

Acknowledgments

  • Thanks to the long list of former Apache Turbine developers