Skip to content

Getting Started

Jump to bottom
Paul edited this page Sep 7, 2023 · 2 revisions

The README briefly showcases the use of worm to get a first impression. To get all of the available features, the following pages will guide you through the use case of worm.

Step-by-Step Instructions

  1. Add Dependency: Add the Maven/Gradle dependency to your project.
  2. Define Entities: Learn how to define an entity, which annotations exist, and what they do.
  3. Create Database and Repository: Set up a database connection that is used by the repository offering CRUD operations by default.
  4. Declare Custom Methods: Extend the default CRUD operations by custom methods that will be directly transferred to database operations based on naming.

Finally, the page Toy Example: Rental Management shows a more complicated scenario that uses all the abovementioned features.

Overview

  1. What is WORM?
    1. Introduction
    2. Capabilities and Limitations
    3. Frequently Asked Questions (FAQ)
  2. Getting Started
    1. Add Dependency
    2. Define Entities
    3. Create Repository and Database
    4. Declare Custom Methods
    5. Toy Example: Rental Management
  3. Contribution
    1. Unit Testing
Clone this wiki locally