Nimble Installation

There are 5 easy steps to complete to get Nimble running inside your host application, all going well you should have it running in under 20 minutes.

Step 1 - Setup the host application

Create a new grails application or choose an existing grails application with which to integrate Nimble. If you're unfamiliar with this process the Grails Quick Start will get you up and running.

For new projects we recommend a grails release of 1.2 (Milestones and Release Candidates acceptable, currently working with 1.2-M3)

Step 2 - Install Nimble

Within your grails application execute the following following command

grails install-plugin nimble <version>

where <version> is the current release of Nimble as indicated on the front page. A range of output will be generated and any plugins Nimble relies on will be automatically installed for you.

Step 3 - Inject Nimble

Now we need to inject Nimble into your host application so that you can customize various components as necessary for your use case. Execute the following command:

grails jack-be-nimble <package> <User Class Name> <Profile Class Name>

e.g: grails jack-be-nimble com.example.domain User Profile

This is a very non-invasive procedure as far as the host application is concerned. One of the main goals of the Nimble project is to make it as invisible as possible when installed in a host application so as not to clutter up your business logic. Once complete you'll have a User and Profile class stored in your preferred package that you can extend as appropriate for your host application.

Step 4 - Configure the host application

We're almost done, all that is left is a little configuration of your host application to make the best possible use of Nimble.

Open the file  grails-app/conf/NimbleConfig.groovy and complete the various configuration variables. Each of these variables are self documenting.

If you'd like to utilize OpenID logins, Facebook logins or Recaptcha verification you'll have to explicitly enable these. THEY ARE DISABLED BY DEFAULT. You can obtain API keys for recaptcha from http://recaptcha.net/. You can obtain Facebook Connect API keys from Facebook. Neither of these steps are required to get started.

Step 5 - Execute your application and get customizing!

Launch your application by executing
grails run-app

Open a browser and navigate to the appropriate URL as indicated by the Grails output. You’ll be welcomed with the basic Grails layout. Click on ‘MainController’ to initiate a secure area. You can login as:

  • admin / admiN123!
  • user / useR123!
  • Any openID account  (if enabled in step 4)
  • Any Facebook account (if enabled in step 4)

The admin user will be able to access the full UI suite while other users will have access to their profile information.

Congratulations Nimble is now fully activated within your application and you're ready to start wiring up your business logic. You can now proceed to the developer documentation if you'd like to make any customisations.

Comments