LightAdmin - [PoC] Pluggable CRUD UI library for Java web applications
The primary goal of this PoC project is to speed up application development by bringing pluggable fully operational data management back-end for JPA based applications and to relieve your codebase for more important stuff.
Features
- DSL configurations: Allows developers to easily configure their administration user interface
- Displaying persistent entities: Customizable Listing & Quick Views with paging & sorting capabilities
- CRUD operations: Complete entities manipulation support (including their associations)
- Automatic Validation: JSR-303 annotation-based validation rules support
- Search: Allows users to search entities by text fields, dates, numeric values & associations
- Filtering Scopes: Use scopes to filter data by predefined criteria
- Pluggable Security: Authentication based on Spring Security
- REST API: Enriching your application with REST API based on Spring Data REST
- Easy integration: Servlet 2.5/3.0 web applications supported
Integration examples
Documentation & Support
- Web site: lightadmin.org
- Documentation & Guides: lightadmin.org/getting-started/
- Wiki: github.com/la-team/light-admin/wiki
- Live demo: lightadmin.org/demo
- CI Server: lightadmin.org/jenkins
- Use Google Groups for posting questions: groups.google.com/group/lightadmin
- Use Stack Overflow for posting questions with lightadmin tag
- Contact LightAdmin Team directly on Twitter: @lightadm_team
Bug Reports
- Bug Reports: github.com/la-team/light-admin/issues
License
- LightAdmin is released under version 2.0 of the Apache License.
Contribute
You're interested in contributing to LightAdmin? AWESOME. Here are the basic steps:
- Fork LightAdmin from here: http://github.com/la-team/light-admin
- Clone your fork
- Hack away
- If necessary, rebase your commits into logical chunks, without errors
- Verify your code by running the test suite, and adding additional tests if able
- Push the branch up to GitHub
- Send a pull request to the la-team/light-admin project
We'll do our best to get your changes in!
Getting started
Declare maven dependency for using with Spring 4.0.X directly from Maven Central
<dependency>
<groupId>org.lightadmingroupId>
<artifactId>lightadminartifactId>
<version>1.2.0.RC1version>
dependency>
or
<dependency>
<groupId>org.lightadmingroupId>
<artifactId>lightadminartifactId>
<version>1.2.0.BUILD-SNAPSHOTversion>
dependency>
For snapshots and LightAdmin compatible with Spring 3.2.X, please declare LA Nexus repositories:
<repositories>
<repository>
<id>lightadmin-nexus-releasesid>
<url>http://lightadmin.org/nexus/content/repositories/releasesurl>
<releases>
<enabled>trueenabled>
<updatePolicy>alwaysupdatePolicy>
releases>
repository>
<repository>
<id>lightadmin-nexus-snapshotsid>
<url>http://lightadmin.org/nexus/content/repositories/snapshotsurl>
<snapshots>
<enabled>trueenabled>
<updatePolicy>alwaysupdatePolicy>
snapshots>
repository>
repositories>
And dependency
<dependency>
<groupId>org.lightadmingroupId>
<artifactId>lightadminartifactId>
<version>1.0.0.M2version>
dependency>
Enable LightAdmin web-module in your web.xml if you have one:
<context-param>
<param-name>light:administration:base-urlparam-name>
<param-value>/adminparam-value>
context-param>
<context-param>
<param-name>light:administration:securityparam-name>
<param-value>trueparam-value>
context-param>
<context-param>
<param-name>light:administration:base-packageparam-name>
<param-value>[package with @Administration configurations, ex.: org.lightadmin.demo.config]param-value>
context-param>
Or enable LightAdmin web-module in your WebApplicationInitializer:
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
servletContext.setInitParameter(LIGHT_ADMINISTRATION_BASE_URL, "/admin");
servletContext.setInitParameter(LIGHT_ADMINISTRATION_BACK_TO_SITE_URL, "http://lightadmin.org");
servletContext.setInitParameter(LIGHT_ADMINISTRATION_BASE_PACKAGE, "org.lightadmin.administration");
super.onStartup(servletContext);
}
Include your JPA persistence provider of choice (Hibernate, EclipseLink, OpenJpa) and setup basic Spring JPA configuration.
xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jdbc="http://www.springframework.org/schema/jdbc"
xmlns:jpa="http://www.springframework.org/schema/data/jpa"
xsi:schemaLocation="http://www.springframework.org/schema/jdbc
http://www.springframework.org/schema/jdbc/spring-jdbc.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/data/jpa
http://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
<bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="jpaVendorAdapter">
<bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter" />
property>
bean>
<bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
<property name="entityManagerFactory" ref="entityManagerFactory" />
bean>
beans>
Create an entity:
@Entity
public class User {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Integer id;
private String firstname;
private String lastname;
// Getters and setters
}
Create an @Administration configuration in the package defined in web.xml previously:
public class UserAdministration extends AdministrationConfiguration<User> {
public EntityMetadataConfigurationUnit configuration( EntityMetadataConfigurationUnitBuilder configurationBuilder ) {
return configurationBuilder.nameField( "firstname" ).build();
}
public ScreenContextConfigurationUnit screenContext( ScreenContextConfigurationUnitBuilder screenContextBuilder ) {
return screenContextBuilder
.screenName( "Users Administration" )
.menuName( "Users" )
.build();
}
public FieldSetConfigurationUnit listView( final FieldSetConfigurationUnitBuilder fragmentBuilder ) {
return fragmentBuilder
.field( "firstname" ).caption( "First Name" )
.field( "lastname" ).caption( "Last Name" )
.build();
}
Voila! You have a brand new LightAdmin back-end configured.
Check Out and Build from Source
-
Clone the repository from GitHub:
$ git clone git://github.com/la-team/light-admin.git -
Navigate into the cloned repository directory:
$ cd light-admin -
The project uses Maven to build:
$ mvn clean install
Running from the Command Line
By default, the app will run in 'embedded' mode which does not require any external setup. The Tomcat 7 Maven plugin is configured for you in the POM file.
-
Navigate into demo application directory:
$ cd lightadmin-sandbox -
Launch Tomcat from the command line:
$ mvn tomcat7:run -
Access the deployed webapp at
http://localhost:8080/lightadmin-sandbox
LightAdmin integration example
We prepared an example how easily you can integrate LightAdmin back-end to existing web application.
It's based on Spring Travel reference application.
-
Clone the repository from GitHub:
$ git clone git://github.com/la-team/lightadmin-spring-travel.git -
Navigate into the cloned repository directory:
$ cd lightadmin-spring-travel -
The project uses Maven to build:
$ mvn clean install -
Launch Tomcat from the command line:
$ mvn tomcat7:run -
Access the deployed webapp at
http://localhost:8080/booking-mvc
Screenshots
Login to LightAdmin:
Dashboard:
List of persistent entities configured:
Search entities by criteria:
Quick view for particular entity:
Editing entity:
Show entity with all fields:
Expected result: ShowView displays values entered in step 2
Actual result: ShowView displays values displayed in step1
![[SECURITY] Use HTTPS to resolve dependencies in Maven Build](https://avatars.githubusercontent.com/u/1323708?v=4)
7 Dec 20, 2022
6 Dec 15, 2022
5 Feb 15, 2022
133 Nov 30, 2022
4 May 21, 2022
10 Nov 29, 2022
51 Apr 24, 2022
86 Dec 4, 2022
1 Nov 11, 2021
11 Dec 16, 2022
8 Mar 19, 2022
4 Feb 23, 2022
18 Oct 23, 2022
1 Feb 1, 2022
1 Jan 31, 2022
9 Mar 2, 2022
5 Mar 2, 2022
5 May 16, 2022