cuba/README.md

<h1 align="center"> <a href="https://www.cuba-platform.com/"><img src="https://github.com/funxies/cuba/blob/master/img/Cuba_Logo.png" alt="CUBA Platform" width="600" align="center"></a>
</h1>  

<h4 align="center">Java RAD framework for enterprise web applications</h4>
  
<p align="center">
<a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat" alt="license" title=""></a>
<a href="https://travis-ci.org/cuba-platform/cuba"><img src="https://travis-ci.org/cuba-platform/cuba.svg?branch=master" alt="Build Status" title=""></a>
<a href="https://gitter.im/cuba-platform/cuba"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/cuba-platform/cuba" title=""></a>
</p>


<div align="center">
  <h3>
    <a href="https://www.cuba-platform.com/" target="_blank">
      Website
    </a>
    <span> | </span>
    <a href="https://www.cuba-platform.com/online-demo" target="_blank">
      Online Demo
    </a>
    <span> | </span>
    <a href="https://www.cuba-platform.com/tutorials" target="_blank">
      Tutorials
    </a>
    <span> | </span>
    <a href="https://www.cuba-platform.com/documentation" target="_blank">
      Documentation
    </a>
    <span> | </span>
    <a href="https://www.cuba-platform.com/discuss/" target="_blank">
      Forum
    </a>
  </h3>
</div>

<p align="center">
<a href="https://twitter.com/CubaPlatform" target="_blank"><img src="https://github.com/cuba-platform/cuba/blob/master/img/twitter.png" height="36px" alt="" title=""></a>
<a href="https://www.facebook.com/CUBAplatform/" target="_blank"><img src="https://github.com/cuba-platform/cuba/blob/master/img/facebook.png" height="36px" margin-left="20px" alt="" title=""></a>
<a href="https://www.linkedin.com/company/cuba-platform/" target="_blank"><img src="https://github.com/cuba-platform/cuba/blob/master/img/linkedin.png" height="36px" margin-left="20px" alt="" title=""></a>
<a href="https://www.youtube.com/channel/UCEmWc8OwhgHnAV7vVVxtglQ" target="_blank"><img src="https://github.com/cuba-platform/cuba/blob/master/img/youtube.png" height="36px" margin-left="20px" alt="" title=""></a>
</p>
  
[CUBA Platform](https://www.cuba-platform.com) is a high level framework for rapid development of enterprise applications with rich web interface.

The simplest way to start using the platform is to [download](https://www.cuba-platform.com/download) CUBA Studio and create a new project in it. A released version of the platform will be downloaded automatically from the artifact repository.

You can also build a snapshot version of the platform from the source code and use it in your project.

To contribute, first refer to [Contributing Code](https://github.com/cuba-platform/cuba/blob/master/CONTRIBUTING.md) for general instructions and requirements for contributing code to the platform.

## Building from Source

In order to build the platform from source, you need to install the following:
* Java 8 Development Kit (JDK)
* [CUBA Gradle Plugin](https://github.com/cuba-platform/cuba-gradle-plugin)

Let's assume that you have cloned CUBA Gradle Plugin and CUBA into the following directories:
```
work/
    cuba/
    cuba-gradle-plugin/
```

Open terminal in the `work` directory and run the following command to build and install the plugin into your local Maven repository (`~/.m2`):
```
cd cuba-gradle-plugin
gradlew install
```

After that, go to the CUBA directory and build and install it with the same command:
```
cd ../cuba
gradlew install
```

## Using Snapshot Version

Edit the `build.gradle` file of your project. Change the `ext.cubaVersion` property and add `mavenLocal()` to the `repositories` section, for example:
```
buildscript {
    ext.cubaVersion = '6.10-SNAPSHOT'
    repositories {
        mavenLocal()
        maven { ...
```
That's all. Now you can generate IDE project files and build and deploy your application based on the snapshot version of the platform from your local repository:
 ```
 gradlew idea
 gradlew deploy
 ```

## Third-party dependencies

The platform uses a number of forked third-party libraries. They can be found in the following source code repositories:

* [eclipselink](https://github.com/cuba-platform/eclipselink)
* [vaadin](https://github.com/cuba-platform/vaadin)
* [vaadin-dragdroplayouts](https://github.com/cuba-platform/vaadin-dragdroplayouts)
* [vaadin-aceeditor](https://github.com/cuba-platform/vaadin-aceeditor)
* [swingx-core](https://github.com/cuba-platform/swingx-core)

All dependencies are also located in our artifacts repository, so you don't have to build them from sources in order to build and use the platform.