Task Runners With Domino/XPages

A repository to contain the front-end assets and instructions for how to utilize Grunt or gulp with a front-end to a Domino/XPages application.

Installation

You must have:

git
a current version of Node ~~or io.js~~ (with npm package manager) *note: io.js merged with Node again (ca. June 2015), so probably skip io.js
Internet access

First, clone this repository, then run npm install which will install some npm dependencies (including json-server, then run bower install, which will install the front-end libraries needed. Lastly, you need to symlink a public/ path to the ODP/WebContent/ directory.

for *nix and Mac operating systems, the command is ln -s ODP/WebContent/ public
for Windows, you'll need to start up the command prompt (from the Start/search, "cmd", right-click and select "run as administrator")
- change directory to the root of the working git repository we set up, then run mklink /d public ODP\WebContent
don't worry about duplicate data, these are both methods for a symbolic link, meaning it's the same file, with multiple path pointers (and the .gitignore file is set up to ignore the public path, so we won't pollute our repository with duplicates)

Usage

Read up on the blog series on task runners on Domino on edm00se.io or try running npm start for the original front-end application with back-end mock.

You can check out the other task available via Grunt or gulp by running grunt or gulp, respectively.

Basic Project Layout

The layout has the On Disk Project (ODP, freshly renamed to that in place of a directory called 'NSF', to eliminate confusion) and its respective WebContent/ directory inside of it, containing the production-ready (aka- 'dist', distribution, or built version of the source client-side assets), additionally a 'src' folder at the root to contain the source client-side assets, unmodified, with 'public' pointing at the ODP/WebContent/ path to provide the built results as the preview in the local browser, in conjunction with json-server as implmemented in the npm start script or, ideally, the gulp tasks.

├── Gruntfile.js
├── ODP
│   └── WebContent
├── ReadMe.md
├── bower.json
├── db.json
├── gulpfile.js
├── package.json
├── public -> NSF/WebContent/
├── routes.json
└── src
    ├── css
    ├── index.html
    ├── js
    ├── libs
    ├── partials
    └── tags

IBM Connect 2016

This content, along with much more, will be component to an application development session at IBM Connect 2016, #1380: A Beard, An App, A Blender: One Developer's Take on Building Apps With Domino/XPages.

History

The want/need to reconcile the concerns involved in modern front-end tooling combined with Domino/XPages back-end performance is born of a love for the web and automation. For more, read up on my chronicles on edm00se.io.

Credits

Considerable credit should go to:

Grunt
gulp
json-server
egghead.io's video lesson on using json-server
scotch.io for having great tutorials on getting started with Grunt and gulp

License

As is my norm for my blog and my GitHub repositories, the work contained herein is licensed under the MIT License (MIT). You may use, alter, and redistribute the code herein (with citation), while expecting no warranty for its use.

edm00se/Task-Runners-With-Domino