Skip to content

Sunilchhipa/elepy

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Travis Button

Version 2.0 is almost here!

Elepy is currently in BETA of its version 2 release. You can download it here:

<dependency>
    <groupId>com.elepy</groupId>
    <artifactId>elepy-basic</artifactId>
    <version>2.0.0-beta-4</version>
</dependency>

Docs can be found at: https://docs.elepy.com

About Elepy

Elepy is a Headless Content Management Framework for Java & Kotlin developed by Ryan Susana. It is extremely customizable! The framework comes bundled with an admin control panel that lets you easily control your content.

It's able to handle extremely complex objects with ease. Read this article: https://medium.com/@ryansusana/rapidly-create-a-customized-cms-with-this-awesome-java-framework-e04ef2ea7810

Downloads

The latest versions of elepy can be found at: https://elepy.com/docs/download

Quick Start

Step One: Create and annotate your POJO's

Create your Rest Model. The only mandatory annotation is @RestModel. This annotation is where you describe the name and /slug of your model. You should also take a look at the awesome collection of Elepy annotations.

@RestModel(name = "Products", slug = "/products")
public class Product {

    @Identifier
    private String productId;
    
    @Text(value = TextType.TEXTAREA, maximumLength = 100)
    private String shortDescription;
    
    @Text(TextType.HTML)//WYSIWYG editor
    private String htmlDescription;

    @PrettyName("Product Name")
    @Required
    @Unique
    private String name;

    @Number(minimum = 0)
    private BigDecimal price;

    @Number(minimum = 0)
    private int stockLeft;

    //Getters and Setters. I like to use Lombok to automate this :D
}

Step Two: Configure Elepy

public static void main(String[] args) {
    DB database = mongo.getDB("product-database");

    new Elepy()
        .registerDependency(DB.class, database)
        .withIPAddress("localhost")
        .onPort(7777)
        .addModel(Product.class)
        //Add an Elepy extension
        //The AdminPanel/CMS is a great start :D
        .addExtension(new ElepyAdminPanel())
        .start();

}

Step Three: Enjoy!

You can now login to the Elepy CMS by going to http://localhost:7777/admin.

Visit https://github.com/RyanSusana/elepy-basic-example for an example

About

Elepy, Headless Content Management Framework

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 67.0%
  • Java 30.9%
  • JavaScript 2.1%