Putnami Web Toolkit

Travis build status Build Status

===================

Putnami Web Toolkit (alias PWT) is a web framework made to boost your productivity, and keep your code maintanable.

Based on GWT, PWT provides a strong framework coupled with a nice widget set. With PWT you are a kind of super hero, more productive than ever, you build amazing webapps will be amazing.

The key features of PWT are :

Discover all features on http://pwt.putnami.org

Usage

To use PWT please have a look at http://pwt.putnami.org/#!GettingStarted. The documentation provides a full step by step tutorials covering all the key features of PWT.

Releases

All our released artifacts are available on the maven central repository.

putnami on maven central.

Snapshot

If use need to use the snapshots you need to install the sonatype snapshot repository https://oss.sonatype.org/content/repositories/snapshots/

repositories {
    mavenCentral()
    maven{ url 'https://oss.sonatype.org/content/repositories/snapshots/'}
}

Samples

We provide samples in this repo in the samples folder :

In each project, you'll find gradle and maven build files.

You can easily run the samples following those commands :

git clone https://github.com/Putnami/putnami-web-toolkit.git
cd putnami-web-toolkit/samples/web-project
gradle jettyRunWar

Then browse the sample on http://localhost:8080/pwt-sample-web.

You can have more info on the build tools on the wiki gradle doc or maven doc.

Build PWT

Note : To build PWT you need gradle. If you are ready to use gradle, please refer to https://www.gradle.org/ to install it.

Project structure

The project is organized that way :

.
+-- core    => contains the core framework project
+-- doc     => contains the documentation webapp project
+-- plugins => contains the provided plugins projects
+-- samples => contains the samples projects
+-- settings => contains the settings and workspace materials
+-- tutorials => contains the step by step tutorials

The samples projects are not children of the root project. They have to be build separately.

Commands

Start to clone the git repository

git clone https://github.com/Putnami/putnami-web-toolkit.git
cd putnami-web-toolkit

To build the framework by yourself, it's very simple:

gradle build

Then all the built artifacts are available in the build/libs of each sub projects

Note : All the commands can be lunch from on specific sub project eg. ./core

Useful gradle tasks:

You can also run webapps such as ./doc or ./samples/web-project with the commands

Help and Contribute

We need you! Any help is welcome. And there is many ways to help us:

Be a nice community member

If you tried and you love PWT. We will be glad to count you as community members. So please :

Of course you will get all our thankfulness if you blog, share and spread PWT around you. All the backlinks on http://putnami.org are very welcome.

Report issues

All issues about bugs or enhancement are precious and will be given careful consideration. We're going to help you in the best delay as can (generally in the day time).

To report an issue, please use the project issue tracker

Contribute

You'd love to contribute your code, nice :) First be sure that your code respect the project code style and formating. All the documentation is here

If you are an eclipse user, it could be nice if you follow the workspace setup instructions.

Every pullrequest will be review with a great consideration, and with a full open mind.

License

The framework is delivered under LGPL v 3.0.

The LGPL v 3.0 allows a free usage of PWT for commercial and open source projects. We equally guarantees that PWT is and will open source for ever.

PWT doesn't affect the license of your application. Using PWT is free of charge so fill free to use and integrate it.

You can have a look at the licence details on a https://www.gnu.org/licenses/lgpl-3.0.txt.



We hope that this framework will help you to build great apps. Best regards.

@PutnamiTeam