Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 1.46 KB
Raw

Contributing to the Posters Demo Store Project

You want to be part of the Posters community? Report bugs or suggest improvements in the issue tracker.

If you are a developer and want to contribute fixes or extensions, create pull requests with your changes. See below for more information on what needs to be installed and how the code is developed.

Prerequisites

Before you can start developing Posters, you will need to:

  • Install JDK 17.
  • Install the latest Maven.
  • Clone this repository to your local disk (or fork the repository).
  • Import the Posters Maven project into your favorite IDE.

Documentation

Posters is built with the Ninja Framework. See their excellent documentation if you need more information on how the application is developed and configured.

Development Cycle

  1. Open a terminal window in the root of the Posters repository on your disk.
  2. Clean the project: 
    mvn clean
  3. Compile the project and enhance the database model classes: 
    mvn process-classes
  4. Run the Posters application in Ninja's "SuperDevMode" (hot-reloading of modified classes and templates): 
    mvn ninja:run
  5. Open http://localhost:8080/ in a Web browser.
  6. Start changing classes or templates in your IDE. Watch the terminal to see the application being reloaded.
  7. Test your changes to the application in the Web browser.