Luminus-Template

A Leiningen template for projects using Luminus.

The template initializes a base Luminus application.

Requirements

Luminus requires Leiningen version 2.x

Usage

The Luminus template ships out of the box with your latest Leiningen. Run the following command to create a new Luminus project which uses the default profile template:

lein new luminus <your project name>

However, if you would like to attach further functionality to your template you can append profile hints for these extended features:

alternative servers

+aleph adds the Aleph server
+http-kit adds the fast HTTP Kit web server to the project
+immutant adds the Immutant web server to the project

databases

+h2 adds db.core namespace and H2 database dependencies
+postgres adds db.core namespace and add PostreSQL database dependencies
+mysql adds db.core namespace and add MySQL/MariaDB database dependencies
+mongodb adds support for MongoDB using the Monger library

misc

+auth adds Buddy dependency and authentication middleware
+cljs adds ClojureScript support to the project along with an example
+cucumber adds support for browser based UI testing with Cucumber and clj-webdriver
+swagger adds support for Swagger-UI using the compojure-api library
+sassc adds support for SASS/SCSS files using SassC command line compiler

To add a profile simply pass it as an argument after your application name, e.g.:

lein new luminus myapp +cljs

You can also mix multiple profiles when creating the application, e.g.:

lein new luminus myapp +auth +postgres

To build as a executable Java ARchive (JAR) standalone, run the following command:

lein ring uberjar

To run the resulting standalone executable .jar file, do as you would with any other:

user$ java -jar target/myapp-0.1.0-SNAPSHOT-standalone.jar

2012-12-15 19:17:23.471:INFO:oejs.Server:jetty-7.x.y-SNAPSHOT
2012-12-15 19:17:23.512:INFO:oejs.AbstractConnector:Started
[email protected]:3000
Server started on port [ 3000 ].
You can view the site at http://localhost:3000

To build a WAR (or Web application ARchive) file run:

lein ring uberwar

You can then easily deploy the resulting WAR to Tomcat or any other Java application server.

License

Distributed under the MIT License.

ludwinas / luminus-template Goto Github PK