Documentation

This documentation describes JUXT's Clojure-based modular system. For a more thorough treatment of the architectural concepts underlying our approach, please see here.

Modular comprises :-

  • a set of pre-written components
  • a template system for creating new projects
  • some optional utility libraries

Modular is based on Stuart Sierra's component library.

See lein-template for further details on project generation.

Modular is free software, licensed until the MIT License, with full sources available on GitHub.

Templates

Templates generate working modular applications that give you a complete Clojure-based project on which to build upon. Unlike many templating systems which generate code that is hard to change, these templates leave you with a simple open architecture which supports change and growth.

All templates incorporate the ideas and techniques described on this website. Which template you should use depends on what you want to do. Browse the documentation for the templates below and decide the best one for you to try first.

Each project generated from a modular template contains the following features as standard.

  • A repl-driven 'reloaded' development work-flow, popularised by Stuart Sierra.

  • A system.clj namespace where components are constructed and their dependency relationships declared.

  • A simple test suite

  • A main.clj namespace, allowing the project to be deployed and run (via Leiningen).

  • Instructions for how to develop and run the project, generated into the project's README.md.

Information on how to use each template is contained in its documentation.

Developer information

Templates are driven from data held in a manifest file within modular's lein-template resources directory. If you'd like to add your own template, feel free to send a pull request.

Available templates

The following templates are available :-

dashboard

intro

hello-world-web

bidi-hello-world

bootstrap-cover

sse

protected-site

templated-bidi-website

clean-blog

Alternatives

There are other projects based on component that are providing pre-written components which are compatible with modular.

  • Daniel Szmulewicz's system project comprises a number of components for libraries not yet supported by modular.

Copyright & License

The MIT License (MIT)

Copyright © 2015 JUXT LTD.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Modularity
Copyright © 2015, LTD.