Skip to content

Latest commit

 

History

History
96 lines (76 loc) · 7.26 KB

README.md

File metadata and controls

96 lines (76 loc) · 7.26 KB
Raw

Dolphin Platform Travis Build Maven Central Slack chat

This repository contains all Java related sources of the Dolphin Platform. Clients for other languages can be found in seperate repositories (JavaScript, AngularJS, Polymer and Android).

If you have any questions or comments about Dolphin Platform you can join our community chat at Slack.

Dolphin Platform Logo

The Dolphin Platform is a framework that implements the presentation model pattern and provides a modern way to create enterprise applications. The Platform provides several client implementations that all can be used in combination with a general sever API.

By doing so you can create enterprise application with a single server and several desktop, web and mobile client implementations. Here the Dolphin Platforms define a mechanism to automatically snchronize models between the server and the client.

For more information read the documentation of the Dolphin Platform.

How to use it

You can simply integrate Dolphin Platform in a Spring based application. To do so you only need to add our Spring plugin:

<dependency>
    <groupId>com.canoo.dolphin-platform</groupId>
    <artifactId>dolphin-platform-server-spring</artifactId>
    <version>1.0.0.CR5</version>
</dependency>

Next to Spring we provide support for JavaEE. To do so you only need to add our JavaEE plugin:

<dependency>
    <groupId>com.canoo.dolphin-platform</groupId>
    <artifactId>dolphin-platform-server-javaee</artifactId>
    <version>1.0.0.CR5</version>
</dependency>

For a JavaFX based client you need to add the following dependency:

<dependency>
    <groupId>com.canoo.dolphin-platform</groupId>
    <artifactId>dolphin-platform-client-javafx</artifactId>
    <version>1.0.0.CR5</version>
</dependency>

Next to JavaFX you can use Dolphin Platform in any web client. You can find additonal information in the readme of the client libraries: (JavaScript, Polymer or Android)

In addition you can use our Maven archetype to create a complete server-client-project based on Dolphin Platform. If you want to create your new project from command line by using an archetype you can simply call this Maven command and select one of the shown Dolphin Platform archetypes:

mvn archetype:generate -Dfilter=com.canoo.dolphin-platform:

Currently the projects contains only a JavaFX based client but it’s planned to add a Polymer based client to the archetypes with the next release.

A complete "Getting started" documentation can be found here.

Useful links

The following GitHub repositories provides additional sources for the Dolphin Platform

🆕🐥:dog: First Timers Support

At Canoo we ❤️ open source. Based on this we develop the complete Dolphin Platform framework as an open source project. If you are new to open source development we have some specific issues for you. Just have a look at all issues with the 'good first issue' label. This issues are reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issues are for you 💝 We use such issues for example to get involved at Hacktoberfest. If you want to know more about open source development and contribution in general you should have a look at this overview.

License

The project is released as open source under the Apache License Version 2.0



About Canoo