Skip to content

Developer Set Up Guide

ChandraAddala edited this page Sep 11, 2014 · 1 revision

Developer Set-Up Guide

To get started developing on the Atom Hopper project you will need to have installed:

  1. Java SE JDK (1.6 and up)
  2. Apache Maven (3.0.3 in current use)
  3. Apache Tomcat (7.0.21 in current use)
  4. Appropriate JDBC jars for Tomcat
  5. Git
  6. IDE of your choice (Intellij, Netbeans, Eclipse, etc)

Note: If you are using Netbeans 7+ then you don't need to install Maven or Apache Tomcat as the Netbeans 7 installation already comes with those.

If you are an Atom Hopper developer (committer) then make sure you have read-write access to the Atom Hopper github account (https://github.com/rackerlabs/atom-hopper).

Once this is all done:

  1. Clone the Atom Hopper project from github to a local working directory of your choice - for Mac users you can use the Mac Github tool (http://mac.github.com/)
  2. Open the project in your IDE, using the pom file as an external model.
  3. Copy the /atomhopper/src/main/resources/META-INF/atom-server.cfg.xml file from the code base to /etc/atomhopper/atom-server.cfg.xml locally.
  4. Copy the /atomhopper/src/main/webapp/META-INF/application-context.xml file from the code base to /etc/atomhopper/application-context.xml locally.
  5. Copy the /server/src/main/resources/logback.xml file from the code base to /etc/atomhopper/logback.xml locally.
  6. Allow Tomcat to create files specific to the project by either:
  • Creating the directory /opt/atomhopper/ and changing permissions to allow the account used to run Tomcat to read/write to it.
  • Changing the /atomhopper/src/main/webapp/META-INF/application-context.xml file to point to a location with sufficient permissions already. To do this change:
 <entry key="hibernate.connection.url" value="jdbc:h2:/opt/atomhopper/atom-hopper-db" />

To:

 <entry key="hibernate.connection.url" value="jdbc:h2:~/atom-hopper-db" />
  1. Build the project in Maven, either through your IDE or CLI.
  2. Start Tomcat with the generated war, also either through your IDE or CLI.
  3. Navigate to [http://localhost:8080/namespace/feed] to verify all is set up correctly. You should see a feed subscription page. (Make sure to set your Servlet Context to /)

At this point you should be ready to go!