Origami

Documentation site

How to pick your build method

Origami modules are written as Sass and JavaScript and need ‘building’ before they can be delivered to users’ browsers. There are two ways to ‘build’ a module. You can use the Build Service which is quick and simple but inflexible. For a more customisable build process Origami has the Origami Build Tools (OBT). To fully customise the process, add Bower to your existing build process. Under the hood, the Origami Build Tools use Bower packages.

You have three choices

1) Origami Build Service - the simplest way. Pull in the Origami CSS and Javascript as external files into your webpage. See tutorial for using the Build Service in production.

2) Manual build with the Origami Build Tools - setting up a build process with Origami Build Tools gives you more customisation. See Origami Build Tools tutorial.

3) Manual build with Bower - adding third-party build tool Bower to your project, lets you have a custom build process (using eg. Webpack) and install Origami components from the command line. See Bower tutorial.

Build service vs manual build comparison

Feature Using the build service Building manually
Server-side technology requirements None, there is no need for any server-side code Node. You'll need Node.js (for package management and build automation).
Set up time Quick, a few minutes at most Slower. If you're not familiar with Node.js and don't have any pre-requisites installed, getting set up could take you a couple of hours
Can I add custom code into the Origami bundle? Not easily. You'd have to publish that code as a standalone repo Yes
Can I use public open source JavaScript modules like jQuery? Yes, provided that they have a CommonJS interface Yes
Can I develop without being online? No, you need to be online if your pages pull resources from the build service Yes

Once you’ve decided how to build Origami’s modules, we have a tutorial for each method.

Build service tutorial Manual build tutorial