eagle-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ralp...@apache.org
Subject incubator-eagle git commit: EAGLE-164: Tutorial for setting up the development environment on mac
Date Sat, 20 Feb 2016 06:35:42 GMT
Repository: incubator-eagle
Updated Branches:
  refs/heads/master 9fb932cfc -> 62db846d6


EAGLE-164: Tutorial for setting up the development environment on mac

https://issues.apache.org/jira/browse/EAGLE-164

Add documentation for setup dev env on MAC.

Reviewer: @ralphsu <ralphsu@apache.org>, Edward
Author: @ralphsu <ralphsu@apache.org> from Ge, Jing

Closes #94

Squashed commit of the following:

commit f491bcf5cd50285ccbc123d4c8c59ab00766a860
Merge: 9fb932c 29db595
Author: Ralph, Su <suliangfei@gmail.com>
Date:   Sat Feb 20 14:29:07 2016 +0800

    Merge branch 'master' of https://github.com/JingGe/incubator-eagle into merge164

commit 29db595b4bf53dbd6cf6321b3f2791db7d73a5cc
Author: Jing Ge <gejing@gmail.com>
Date:   Thu Feb 18 12:15:35 2016 +0100

    Update SetupDevelopmentEnvOnMac.md

commit caf18d6f55b01dca9363996f9633664f8703ce92
Author: Jing Ge <gejing@gmail.com>
Date:   Thu Feb 18 12:00:57 2016 +0100

    Update SetupDevelopmentEnvOnMac.md

commit e1244302b5f2dc109765853a21496f9b83653bb8
Author: Jing Ge <gejing@gmail.com>
Date:   Thu Feb 18 11:59:19 2016 +0100

    Update SetupDevelopmentEnvOnMac.md

commit 5d15975ed9978c11077e9086923af6a2424ddb3e
Author: jinge <gejing@gmail.com>
Date:   Thu Feb 18 11:54:52 2016 +0100

    setup tutorial on mac

commit 67eab67aeecea120aff5d1fa803e876bd4a80759
Author: jinge <gejing@gmail.com>
Date:   Thu Feb 18 11:49:19 2016 +0100

    add new file


Project: http://git-wip-us.apache.org/repos/asf/incubator-eagle/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-eagle/commit/62db846d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-eagle/tree/62db846d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-eagle/diff/62db846d

Branch: refs/heads/master
Commit: 62db846d6df909639b6b57d4951358634d5f3bfc
Parents: 9fb932c
Author: Ralph, Su <suliangfei@gmail.com>
Authored: Sat Feb 20 14:30:21 2016 +0800
Committer: Ralph, Su <suliangfei@gmail.com>
Committed: Sat Feb 20 14:30:21 2016 +0800

----------------------------------------------------------------------
 eagle-tutorial/SetupDevelopmentEnvOnMac.md | 103 ++++++++++++++++++++++++
 1 file changed, 103 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-eagle/blob/62db846d/eagle-tutorial/SetupDevelopmentEnvOnMac.md
----------------------------------------------------------------------
diff --git a/eagle-tutorial/SetupDevelopmentEnvOnMac.md b/eagle-tutorial/SetupDevelopmentEnvOnMac.md
new file mode 100644
index 0000000..68adfe7
--- /dev/null
+++ b/eagle-tutorial/SetupDevelopmentEnvOnMac.md
@@ -0,0 +1,103 @@
+How to setup the Eagle development environment on Mac
+===============================================
+
+This tutorial is based Mac OS X. It can be used as a reference guide for other OS like Linux
or Windows as well.  To save your time of jumping back and forth between different web pages,
all necessary references will be point out. 
+
+Prerequisite
+-------
+
+### - HomeBrew 
+Make sure you have HomeBrew installed on your mac. If not, please run:
+
+>\$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+you can find more information about HomeBrew at http://brew.sh/ .
+
+### - Scala & SBT
+Some core eagle modules are written with scala. To install Scala and SBT, just run:
+
+> $ brew install scala
+
+> $ brew install sbt
+
+### - npm
+
+Eagle-webservice module uses npm. To install it, run:
+
+> $ brew install npm
+
+
+### - Maven
+Eagle is built with maven:
+> 
+> $ brew install maven
+
+
+### - HomeBrew Cask 
+Install HomeBrew Cask:
+> $ brew install caskroom/cask/brew-cask
+
+Next, install JDK via HomeBrew:
+
+> $ brew cask search java
+
+you will see all available JDK versions and you can install multiple JDK versions in this
way. For eagle please choose java7 to install:
+
+> $ brew cask install java7
+
+-
+> **Note:**
+> During this writing SBT has issue with JDK 8. This issue has been tested confirmed by
using: 
+> -Java 1.8.0_66
+> -Maven 3.3.9
+> -Scala 2.11.7
+> -Sbt 0.13.9
+
+you can find more information about HomeBrew Cask at http://caskroom.io/ .
+
+### - Jenv 
+
+you can use Jenv to manage installed multiple Java versions. To install it:
+> $ brew install https://raw.githubusercontent.com/entrypass/jenv/homebrew/homebrew/jenv.rb
+
+and make sure activate it automatically:
+
+> \$ echo 'eval "$(jenv init -)"' >> ~/.bash_profile
+
+-
+> **Note:**
+> There is a known issue at this writing: https://github.com/gcuisinier/jenv/wiki/Trouble-Shooting
+> Please make sure JENV_ROOT has been set before jenv init:
+> $ export JENV_ROOT=/usr/local/opt/jenv
+
+Now let Jenv manage JDK versions (remember In OSX all JVMs are located at /Library/Java/JavaVirtualMachines):
+
+> \$ jenv add /Library/Java/JavaVirtualMachines/jdk1.8.0_66.jdk/Contents/Home/
+$ jenv add /Library/Java/JavaVirtualMachines/jdk1.7.0_80.jdk/Contents/Home/
+
+and
+
+> $ jenv rehash
+
+You can see all managed JDK versions:
+
+> $ jenv versions
+
+set global java version:
+
+> $ jenv global oracle64-1.8.0.66
+
+switch to your eagle home directory and set the local JDK version for eagle:
+
+> $ jenv local oracle64-1.7.0.80
+
+you can find more information about Jenv at https://github.com/rbenv/rbenv and http://hanxue-it.blogspot.com/2014/05/installing-java-8-managing-multiple.html.
+
+Build Eagle
+-----------
+
+Go to Eagle home directory and run:
+
+> mvn -DskipTests clean package
+
+That's all. Now you have runnable eagle on your Mac. Have fun. :-)


Mime
View raw message