Google Git
Sign in
apache / incubator-retired-gearpump-site / f2a69d38efa9a4415d78fca68868f176ad60dd49 / . / content / releases / latest / dev / dev-ide-setup / index.html
blob: d185aa933006935e6c8c708d5fb0314f88332722 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>IDE Setup - Apache Gearpump(incubating)</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../../css/highlight.css">
<script>
// Current page data
var mkdocs_page_name = "IDE Setup";
var mkdocs_page_input_path = "dev/dev-ide-setup.md";
var mkdocs_page_url = "/dev/dev-ide-setup/index.html";
</script>
<script src="../../js/jquery-2.1.1.min.js"></script>
<script src="../../js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="../../js/highlight.pack.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> Apache Gearpump(incubating)</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1">
<a class="" href="../../index.html">Overview</a>
</li>
<li class="toctree-l1">
<span class="caption-text">Introduction</span>
<ul class="subnav">
<li class="">
<a class="" href="../../introduction/submit-your-1st-application/index.html">Submit Your 1st Application</a>
</li>
<li class="">
<a class="" href="../../introduction/commandline/index.html">Client Command Line</a>
</li>
<li class="">
<a class="" href="../../introduction/basic-concepts/index.html">Basic Concepts</a>
</li>
<li class="">
<a class="" href="../../introduction/features/index.html">Technical Highlights</a>
</li>
<li class="">
<a class="" href="../../introduction/message-delivery/index.html">Reliable Message Delivery</a>
</li>
<li class="">
<a class="" href="../../introduction/performance-report/index.html">Performance</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<span class="caption-text">Deployment</span>
<ul class="subnav">
<li class="">
<a class="" href="../../deployment/deployment-local/index.html">Local Mode</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-standalone/index.html">Standalone Mode</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-yarn/index.html">YARN Mode</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-docker/index.html">Docker Mode</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-ui-authentication/index.html">UI Authentication</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-ha/index.html">High Availability</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-msg-delivery/index.html">Reliable Message Delivery</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-configuration/index.html">Configuration</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-resource-isolation/index.html">Resource Isolation</a>
</li>
<li class="">
<a class="" href="../../deployment/deployment-security/index.html">YARN Security Guide</a>
</li>
<li class="">
<a class="" href="../../deployment/get-gearpump-distribution/index.html">How to Get Your Gearpump Distribution</a>
</li>
<li class="">
<a class="" href="../../deployment/hardware-requirement/index.html">Hardware Requirement</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<span class="caption-text">Programming Guide</span>
<ul class="subnav">
<li class="">
<a class="" href="../dev-write-1st-app/index.html">Write Your 1st App</a>
</li>
<li class="">
<a class="" href="../dev-custom-serializer/index.html">Customized Message Passing</a>
</li>
<li class="">
<a class="" href="../dev-connectors/index.html">Gearpump Connectors</a>
</li>
<li class="">
<a class="" href="../dev-storm/index.html">Storm Compatibility</a>
</li>
<li class=" current">
<a class="current" href="index.html">IDE Setup</a>
<ul class="subnav">
<li class="toctree-l3"><a href="#intellij-ide-setup">Intellij IDE Setup</a></li>
<li class="toctree-l3"><a href="#eclipse-ide-setup">Eclipse IDE Setup</a></li>
</ul>
</li>
<li class="">
<a class="" href="../dev-non-streaming-example/index.html">Non Streaming Examples</a>
</li>
<li class="">
<a class="" href="../dev-rest-api/index.html">REST API</a>
</li>
<li class="">
<a class="" href="../../api/scala/index.html">Scala API</a>
</li>
<li class="">
<a class="" href="../../api/java/index.html">Java API</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<span class="caption-text">Internals</span>
<ul class="subnav">
<li class="">
<a class="" href="../../internals/gearpump-internals/index.html">Gearpump Internals</a>
</li>
</ul>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Apache Gearpump(incubating)</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li>Programming Guide &raquo;</li>
<li>IDE Setup</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/apache/incubator-gearpump/edit/master/docs/contents/dev/dev-ide-setup.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h3 id="intellij-ide-setup">Intellij IDE Setup</h3>
<ol>
<li>In Intellij, download scala plugin. We are using scala version 2.11</li>
<li>Open menu "File-&gt;Open" to open Gearpump root project, then choose the Gearpump source folder.</li>
<li>All set.</li>
</ol>
<p><strong>NOTE:</strong> Intellij Scala plugin is already bundled with sbt. If you have Scala plugin installed, please don't install additional sbt plugin. Check your settings at "Settings -&gt; Plugins"
<strong>NOTE:</strong> If you are behind a proxy, to speed up the build, please set the proxy for sbt in "Settings -&gt; Build Tools &gt; SBT". in input field "VM parameters", add </p>
<pre class="codehilite"><code class="language-bash">-Dhttp.proxyHost=&lt;proxy host&gt;
-Dhttp.proxyPort=&lt;port like 911&gt;
-Dhttps.proxyHost=&lt;proxy host&gt;
-Dhttps.proxyPort=&lt;port like 911&gt;</code></pre>
<h3 id="eclipse-ide-setup">Eclipse IDE Setup</h3>
<p>I will show how to do this in eclipse LUNA.</p>
<p>There is a sbt-eclipse plugin to generate eclipse project files, but seems there are some bugs, and some manual fix is still required. Here is the steps that works for me:</p>
<ol>
<li>Install latest version eclipse luna</li>
<li>Install latest scala-IDE http://scala-ide.org/download/current.html I use update site address: http://download.scala-ide.org/sdk/lithium/e44/scala211/stable/site</li>
<li>Open a sbt shell under the root folder of Gearpump. enter "eclipse", then we get all eclipse project file generated.</li>
<li>Use eclipse import wizard. File-&gt;Import-&gt;Existing projects into Workspace, make sure to tick the option "Search for nested projects"</li>
<li>Then it may starts to complain about encoding error, like "IO error while decoding". You need to fix the eclipse default text encoding by changing configuration at "Window-&gt;Preference-&gt;General-&gt;Workspace-&gt;Text file encoding" to UTF-8.</li>
<li>Then the project gearpump-external-kafka may still cannot compile. The reason is that there is some dependencies missing in generated .classpath file by sbt-eclipse. We need to do some manual fix. Right click on project icon of gearpump-external-kafka in eclipse, then choose menu "Build Path-&gt;Configure Build Path". A window will popup. Under the tab "projects", click add, choose "gearpump-streaming"</li>
<li>All set. Now the project should compile OK in eclipse.</li>
</ol>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../dev-non-streaming-example/index.html" class="btn btn-neutral float-right" title="Non Streaming Examples">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../dev-storm/index.html" class="btn btn-neutral" title="Storm Compatibility"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a href="https://github.com/apache/incubator-gearpump" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../dev-storm/index.html" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../dev-non-streaming-example/index.html" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="../../js/theme.js"></script>
</body>
</html>