Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<p>WARNING: When this was copied over from assembla, I couldn't find a way to make pieces of the code bold. Some of this may not make sense.</p>

<h1>Creating a Project</h1>
<p>Create a new project directory structure like this:</p>

<table class="wysiwyg-macro" data-macro-name="noformat" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vZm9ybWF0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
myproject
myproject/src
myproject/src/main
myproject/src/main/clojure
myproject/src/test
myproject/src/test/clojure
</pre></td></tr></table>

<p>In the top-level myproject directory, create a file named pom.xml, and copy the template below. Replace the bold-face parts with your own domain name, project name, URL, and description.</p>
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;?xml version="1.0" encoding="UTF-8"?>
&lt;project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http//www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                             http://maven.apache.org/maven-v4_0_0.xsd">
  &lt;properties>
    &lt;project.build.sourceEncoding>UTF-8&lt;/project.build.sourceEncoding>
  &lt;/properties>
  &lt;modelVersion>4.0.0&lt;/modelVersion>
  &lt;groupId>com.example&lt;/groupId>
  &lt;artifactId>myproject&lt;/artifactId>
  &lt;version>1.0.0-SNAPSHOT&lt;/version>
  &lt;url>http://example.com/&lt;/url>
  &lt;description>My new project&lt;/description>
  &lt;name>${artifactId}&lt;/name>
  &lt;licenses>
    &lt;license>
      &lt;name>Eclipse Public License 1.0&lt;/name>
      &lt;url>http://opensource.org/licenses/eclipse-1.0.php&lt;/url>
      &lt;distribution>repo&lt;/distribution>
    &lt;/license>
  &lt;/licenses>
  &lt;dependencies>
    &lt;dependency>
      &lt;groupId>org.clojure&lt;/groupId>
      &lt;artifactId>clojure&lt;/artifactId>
      &lt;version>1.1.0&lt;/version>
    &lt;/dependency>
    &lt;dependency>
      &lt;groupId>org.clojure&lt;/groupId>
      &lt;artifactId>clojure-contrib&lt;/artifactId>
      &lt;version>1.1.0&lt;/version>
    &lt;/dependency>
    &lt;dependency>
      &lt;groupId>swank-clojure&lt;/groupId>
      &lt;artifactId>swank-clojure&lt;/artifactId>
      &lt;version>1.2.1&lt;/version>
    &lt;/dependency>
  &lt;/dependencies>
  &lt;repositories>
    &lt;repository>
      &lt;id>clojars&lt;/id>
      &lt;url>http://clojars.org/repo&lt;/url>
    &lt;/repository>
    &lt;repository>
      &lt;id>clojure-snapshots&lt;/id>
      &lt;url>http://build.clojure.org/snapshots&lt;/url>
      &lt;releases>
        &lt;enabled>false&lt;/enabled>
      &lt;/releases>
      &lt;snapshots>
        &lt;enabled>true&lt;/enabled>
      &lt;/snapshots>
    &lt;/repository>
    &lt;repository>
      &lt;id>clojure-releases&lt;/id>
      &lt;url>http://build.clojure.org/releases&lt;/url>
      &lt;releases>
        &lt;enabled>true&lt;/enabled>
      &lt;/releases>
      &lt;snapshots>
        &lt;enabled>false&lt;/enabled>
      &lt;/snapshots>
    &lt;/repository>
  &lt;/repositories>
  &lt;build>
    &lt;plugins>
      &lt;plugin>
        &lt;groupId>com.theoryinpractise&lt;/groupId>
        &lt;artifactId>clojure-maven-plugin&lt;/artifactId>
        &lt;version>1.3.2&lt;/version>
        &lt;executions>
          &lt;execution>
            &lt;id>compile-clojure&lt;/id>
            &lt;phase>compile&lt;/phase>
            &lt;goals>
              &lt;goal>compile&lt;/goal>
            &lt;/goals>
          &lt;/execution>
          &lt;execution>
            &lt;id>test-clojure&lt;/id>
            &lt;phase>test&lt;/phase>
            &lt;goals>
              &lt;goal>test&lt;/goal>
            &lt;/goals>
          &lt;/execution>
        &lt;/executions&gt;
      &lt;/plugin>
    &lt;/plugins>
  &lt;/build>
&lt;/project>
</pre></td></tr></table>
<p>You can also replace the license name/url with a different license if you wish.</p>

<h2>Running Clojure</h2>
<p>To start a Clojure REPL (read-eval-print-loop) in your new project, type:</p>

<p><code>mvn clojure:repl</code></p>

<p>To start a SWANK server (for connecting to Emacs SLIME), type:</p>

<p><code>mvn clojure:swank</code></p>

<p>Then run M-x slime-connect from within Emacs</p>

<h2>Adding Your Own Code</h2>
<p>Add your .clj source files under src/main/clojure. When creating file names from namespace names, periods become directory separators and hyphens become underscores. So a namespace like</p>

<p><code>(ns com.example.foo-library)</code></p>

<p>Would go in the file src/main/clojure/com/example/foo_library.clj</p>

<p>Follow the same convention for test source code (using clojure.test), adding files under src/test/clojure.</p>

<h2>Adding Dependencies</h2>
<p>Open-source Java libraries can be found on search engines such as MVNrepository and Jarvana. Many Clojure libraries can be found on Clojars.</p>

<p>Once you have found a dependency, add its group/artifact/version information to the &lt;dependencies&gt; section of pom.xml.</p>

<p>For example, to add a dependency on Compojure, add the following code to pom.xml:</p>

<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;dependencies>
  &lt;!-- ... other dependencies ... -->
  &lt;dependency>
    &lt;groupId>compojure&lt;/groupId>
    &lt;artifactId>compojure&lt;/artifactId>
    &lt;version>0.4.0-SNAPSHOT&lt;/version>
  &lt;/dependency>
  &lt;!-- ... -->
&lt;/dependencies>
</pre></td></tr></table>

<p>Note: Be aware that different libraries may be written for different version of Clojure. Check the library documentation to make sure you have the right version.</p>

<h2>Using Different Clojure Versions</h2>
<p>To use the 1.2.0 development snapshots of Clojure and clojure-contrib, change this block in pom.xml:</p>
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
    &lt;dependency>
      &lt;groupId>org.clojure&lt;/groupId>
      &lt;artifactId>clojure&lt;/artifactId>
      &lt;version>1.1.0&lt;/version>
    &lt;/dependency>
    &lt;dependency>
      &lt;groupId>org.clojure&lt;/groupId>
      &lt;artifactId>clojure-contrib&lt;/artifactId>
      &lt;version>1.1.0&lt;/version>
    &lt;/dependency>
</pre></td></tr></table>

<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
    &lt;dependency>
      &lt;groupId>org.clojure&lt;/groupId>
      &lt;artifactId>clojure&lt;/artifactId>
      &lt;version>1.2.0-master-SNAPSHOT&lt;/version>
    &lt;/dependency>
    &lt;dependency>
      &lt;groupId>org.clojure&lt;/groupId>
      &lt;artifactId>clojure-contrib&lt;/artifactId>
      &lt;version>1.2.0-SNAPSHOT&lt;/version>
    &lt;/dependency>
</pre></td></tr></table>