Title: Getting Started
Notice:    Licensed to the Apache Software Foundation (ASF) under one
           or more contributor license agreements.  See the NOTICE file
           distributed with this work for additional information
           regarding copyright ownership.  The ASF licenses this file
           to you 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.

We use [Apache Subversion][1] for version control. You can [browse our 
repository][2] in your web browser.

## Getting the source code

The instructions on this page will help you get started using command line tools. If you prefer to work in an IDE then we have [separate instructions][3] for you.

### Git access

    git clone https://git-wip-us.apache.org/repos/asf/rave

## Building and Running

To build from source code:

### Requirements:
 * Sources compilation require Java SE 6 or higher.
 * The project is built with Apache Maven 3+ (version 3.0.3 or later is *required*) [Download][4] and [install][5]
    
### Apache Rave Project

To build the Apache Rave project invoke maven from the project root directory:

    mvn install

If you have any problems relating to the rave-master project, see the 
"Apache Rave Master Project" section at the end of this document.

If Maven can't find the artifacts *oauth-httpclient4* or *caja*, you are
probably behind a Maven proxy (repository manager) that doesn't
know about the corresponding repositories. Rave depends transitively on
these artifacts via Shindig. Shindig, thus adds repositories via their
[pom.xml][7] files. If your proxy doesn't know about these repositories
you have to add these URLs in your proxy-configuration:

    http://oauth.googlecode.com/svn/code/maven/
    http://google-caja.googlecode.com/svn/maven/

### Deploying and Running on Tomcat

To run a local Tomcat instance with rave-shindig and rave-portal and Wookie deployed:

  - navigate to the rave-portal subdirectory and invoke:
  
    `mvn cargo:run`

     *If you are behind a proxy, then you can specify it with the following command*

   *`mvn -Dcargo.args="-Dhttp.proxyHost=PROXYHOST -Dhttp.proxyPort=PROXYPORT -Dhttp.nonProxyHosts=NONPROXYHOST" cargo:run`*
 
  - open url http://localhost:8080/portal in a browser
  - press Ctrl-C in the console to stop Tomcat again

### Logging in

Once the server is running:

  * localhost:8080/portal
  * login as one of the following test users (password is same as username)
    * canonical (this user has admin rights)
    * john.doe
    * jane.doe
    * johnldap
    * OpenID: http://rave2011.myopenid.com/ (password rave2011)

### Apache Rave Master Project

The Apache Rave project depends on the separate Apache Rave Master project which defines general and global settings
for the whole of the Apache Rave project, independent of a specific release. As its rave-master-pom is already published to the
Apache Snapshots repository, there is no need to check it out manually and build it locally yourself, unless changes are
needed on general and global level.
    
If so needed, the Apache Rave Master project can be checked out from:

      http://svn.apache.org/repos/asf/rave/rave-master-pom/trunk rave-master-pom.

After check out, cd into rave-master-pom and invoke maven to install it using:

      mvn install

### Running the integration tests

See the article about [integration tests][6]

  [1]: http://subversion.apache.org
  [2]: http://svn.apache.org/viewvc/rave/
  [3]: ide-settings-and-debugging.html
  [4]: http://maven.apache.org/download.html
  [5]: http://maven.apache.org/download.html#Installation
  [6]: integration-tests.html
  [7]: http://svn.apache.org/repos/asf/shindig/trunk/pom.xml