Page Comparison

Table of Contents

IDE Setup

• Download intelliJ community edition the IntelliJ Community Edition from http://www.jetbrains.com/idea/download/
• Import settings into IntelliJ as explained here:
  
  • Coding Standards
  • Set Imports: Preferences -> Code Style -> Java -> Imports. Uncheck "Use fully qualified class names in javadocs"

• Install Homebrew
  • ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
• Install git, git-flow and maven:

  • brew install git

  • brew install git-flow 
  • brew install maven
• Make sure git is version 1.8.x or greater installed on your machine:

  • $ git --version

    git version 2.8.2

• Download node.js js: http://nodejs.org/download/
  
  • brew install nodejs
• Please refer to Build System & CI on how to setup building of CDAP.

Creating an IntelliJ project

• Clone the CDAP project, if not done already
  • git clone git@github.com:caskdata/cdap.git
• Open IntelliJ and import the CDAP project
  
  1. Go to menu File -> Import Project ...
  2. Select the pom.xml under the CDAP directory
  3. Check Import Maven projects automatically and Automatically download: Sources, Documentations boxes in the Import Project from Maven popup.
  4. Click next and the new CDAP project will be created.

Setting up Checkstyle in IntelliJ

For more information on the rules enforced by checkstyle, see Java Coding Standards. 

Setting up

...

Auto Copyright

...

Header in IntelliJ

In IntelliJ, do this:

1. Go to menu IntelliJ IDEA -> Preferences…
2. Expand the Copyright setting on the left (under Project Settings)
3. Select Copyright Profiles and add a new Copyright Profile (there is a + button in the top-middle)
4. Give the profile a name (e.g. Cask Apache v2)

5. Paste the following text to the Copyright text box

   Code Block
   language text
   Copyright © $today.year Cask Data, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

6. In the Allow replacing copyright if old copyright contains box, enter Copyright.
7. Click on Copyright on the left again and add a new scope of All with the copyright profile added in above step.
8. Note: if there is an existing copyright in a file, and you are modifying the file (rather than completely replacing it), extend the copyright rather than replacing it:
   "Copyright © 2014" becomes Copyright © 2014-2016" (or similar).

Build

Make sure git is version 1.8.x or greater

...

• in bash: export PATH=<PATH_TO_CDAP_REPO>:$PATH

Build and run Local Standalone CDAP

cd <path_to_cdap_repo>
MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=128m" mvn package -pl cdap-standalone,cdap-app-templates/cdap-etl,cdap-examples -am -amd -DskipTests -P examples,templates,dist,release,unit-tests
cd cdap-standalone/target
unzip cdap-sdk-<version>-SNAPSHOT.zip && cd cdap-sdk-<version>-SNAPSHOT
cd bin
./cdap.sh start

...