Origami Frontend Components & Services
Origami Frontend Components & Services

The Origami specification is deprecated. Origami projects may diverge from the specification, however, any new divergence will be released as a major version.

Read our blogpost on why the Origami specificaiton has been deprecated for more information.

Origami Specification

The Origami specification outlines the requirements for Origami-compatible components and services. This is a normative specification; non-normative (informative) sections are indicated explicitly or by inset and boxed asides. The words MUST, MUST NOT, SHOULD, SHOULD NOT, and MAY have the meaning given to them in RFC 2119.

Overview

This section is non-normative.

Conforming to the Origami specification when building components or services is beneficial for a number of reasons:

Naming

The name repository refers to a collection of files and folders which are stored in version control (such as Git.

The name component refers to a repository that:

The name service refers to a repository that:

The name manifest refers to a file in a repository that:

Component Specification

A specification which describes what is required for a front-end component to be considered Origami-compatible, and included in our registry. Read the component specification

Service Specification

A specification which describes what is required when building Origami web services. Read the service specification

Origami.json Manifest Specification

A specification which describes the required structure of an Origami.json manifest file. Read the manifest specification