Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hakandilek/play2-crud
Simple CRUD & DAO implementation for play2
https://github.com/hakandilek/play2-crud
crud crud-controllers dao java play-framework play2-crud playframework
Last synced: 12 days ago
JSON representation
Simple CRUD & DAO implementation for play2
- Host: GitHub
- URL: https://github.com/hakandilek/play2-crud
- Owner: hakandilek
- License: other
- Created: 2013-01-30T12:49:07.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-04-18T09:43:06.000Z (over 7 years ago)
- Last Synced: 2024-10-13T15:44:28.467Z (26 days ago)
- Topics: crud, crud-controllers, dao, java, play-framework, play2-crud, playframework
- Language: Java
- Homepage:
- Size: 1000 KB
- Stars: 142
- Watchers: 24
- Forks: 52
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
play2-crud
==========
[](https://gitter.im/hakandilek/play2-crud?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Powerful CRUD & DAO implementation with REST interface for [play framework](http://github.com/playframework/play) 2.x
For the [Typesafe Activator](http://typesafe.com/activator) check [play2-crud-activator](https://github.com/hakandilek/play2-crud-activator).
### Some screenshots
* index page
* create page
* list page
## Quick Start
Follow these steps to use play2-crud. You can also use it partially just for DAO or CRUD controllers. If you think any part needs further explanation, please report a new issue.
### Add play2-crud dependency
You can begin with adding play2-crud dependency inside `conf/Build.scala` file.
* Add app dependency:
```
val appDependencies = Seq(
javaCore, javaJdbc, javaEbean,
"play2-crud" % "play2-crud_2.10" % "0.7.0"
)
```
* Dependency version is for version 0.7.0 defined, but you can use the latest version.
* Add custom maven repositories:
```
val main = play.Project(appName, appVersion, appDependencies).settings(
//maven repository
resolvers += "release repository" at "http://hakandilek.github.com/maven-repo/releases/",
resolvers += "snapshot repository" at "http://hakandilek.github.com/maven-repo/snapshots/"
)
```
### Associate Global settings
#### Direct reference
If you don't want to override the play application launcher, you just have to notice to play that the class to use as launcher is now GlobalCRUDSettings. Change the `application.global` configuration key in the `conf/application.conf` file, and use `play.utils.crud.GlobalCRUDSettings`:
```
...
application.global=play.utils.crud.GlobalCRUDSettings
...
```
### Define routes
```
# CRUD Controllers
-> /app play.crud.Routes
# REST API
-> /api play.rest.Routes
```
### Define model
* Model class has to implement `play.utils.dao.BasicModel` with the type parameter indicating the type of the `@Id` field.
```java
@Entity
public class Sample extends Model implements BasicModel {
@Id
private Long key;
@Basic
@Required
private String name;
public Long getKey() {
return key;
}
public void setKey(Long key) {
this.key = key;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
```
* Here the `Sample` model class implements `BasicModel` where `key` field indicated with `@Id` is `Long`.
... call [http://localhost:9000/app](http://localhost:9000/app) and voila!
# Samples
* [Sample with basic dynamic CRUD controllers](https://github.com/hakandilek/play2-crud/tree/master/samples/play2-crud-simple)
* [Sample with custom views](https://github.com/hakandilek/play2-crud/tree/master/samples/play2-crud-customView) is a full featured sample.
* [Full featured sample with DAO and DAOListeners](https://github.com/hakandilek/play2-crud/tree/master/samples/play2-crud-sample)
* [Sample with Cache usage](https://github.com/hakandilek/play2-crud/tree/master/samples/play2-cache-sample)
# HOW-TO
Here you can find some HOW-TO documents introducing some powerful functionality:
* [HOW-TO use simple CRUD](docs/simple-crud.md)
* [HOW-TO define a custom DAO](docs/custom-dao.md)
* [HOW-TO define a custom Controller](docs/custom-controller.md)
* [HOW-TO use DAO Listeners](docs/dao-listeners.md)
* [HOW-TO use dynamic REST Controllers](docs/rest-controllers.md)
* [HOW-TO use custom REST Controllers](docs/custom-rest-controllers.md)
* [HOW-TO Override Play Launcher](docs/override-play-launcher.md)