usergrid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From snoopd...@apache.org
Subject [23/51] [abbrv] git commit: Update README.md
Date Thu, 13 Feb 2014 14:21:07 GMT
Update README.md

Adding a how to build and run locally section.

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

Branch: refs/heads/two-dot-o
Commit: bc3dfbad34533f2f6d741554d8af15a578f8d243
Parents: 3d3ebf5
Author: Dave Johnson <dave.johnson@rollerweblogger.org>
Authored: Mon Feb 10 17:18:37 2014 -0500
Committer: Dave Johnson <dave.johnson@rollerweblogger.org>
Committed: Mon Feb 10 17:18:37 2014 -0500

----------------------------------------------------------------------
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bc3dfbad/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index fdb5e4a..faaf832 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,35 @@ This repository contains all the code for Apache Usergrid, including the
server
 * the admin portal and the many SDKs. A pure HTML5+JavaScript app allowing you to register
developers and let them manage their apps in a multi-tenant cluster. Located under [`/portal`](portal)
 * SDKs for [iOS](sdks/ios), [Android](sdks/android), [HTML5/JavaScript](sdks/html5-javascript),
[node.js](sdks/nodejs), [Ruby on Rails](ruby-on-rails), [pure Ruby](sdks/ruby), [PHP](sdks/php),
(server-side) [Java](sdks/java) and [.Net / Windows](sdks/dotnet), located in their respective
subdirectories under [`/sdks`](sdks).
 
+How to build and run Usergrid locally
+-------------------------------------
+
+It's easy to build and run Usergrid locally. All you need is the Java JDK 1.7 and Maven 3.0.5
installed and on your path. Here's how you do it. First you get the source code like this:
+
+    git clone git@github.com:usergrid/usergrid.git
+
+Next, you change directories into the Java SDK package and build the SDK:
+
+    cd usergrid/sdks/java
+    mvn clean install
+
+Next, you change directory into the stack directory and build the Usergrid WAR and launcher:
+
+    cd ../..
+    cd stack
+    mvn clean install
+
+Finally, you can run Usergrid locally by using the all-in-one launcher, which includes a
web server (Grizzly) and the database (Cassandra):
+
+    cd launcher
+    java -jar target/usergrid-launcher-0.0.29-SNAPSHOT.jar
+
+(you might have to substitute 0.0.29-SNAPSHOT with something newer)
+
+You should see the Usergrid launcher UI and from there you can start Usergrid and access
the admin console.
+
+If not, subscribe to the [user mailing list](mailto:user-subscribe@usergrid.incubator.apache.org)
and we can help you out.
+    
 
 Backwards compatibility
 -----------------------


Mime
View raw message