Documentation and development interface for component libraries

@patternplate/api

• Framework independent
• Bring design docs to live with real components
• Powerful search and meta data system

This is the contributor documentation for @patternplate/cli For user docs see patternplate.github.io

About @patternplate/api

@patternplate/api provides an express middleware for use with @patternplate/client, as well as a web socket emitting data about file changes and compilation processes.

Endpoints

• / - Web socket
• /state.json - Document and pattern tree
• /demo/*.html - Demo renderings

WebSocket

The web socket on / emits the following events:

• {type: "change", "payload": {file: "string", p: conntentType: "pattern" | "doc"}"}
• {type: "error", "payload": Error"}
• {type: "start", "payload": {target: "node" | "web"}}
• {type: "done", "payload": {target: "node" | "web"}}

Quick start

git clone https://github.com/patternplate/patternplate.git
cd patternplate/packages/cli
yarn
yarn start

Usage

const http = require("http");
const api = require("@patternplate/api");

(async () => {
  const server = http.createServer();

  const apiRoute = await api({
    cwd: process.cwd(),
    server
  });

  const app = express().use("/api/", apiRoute)
})();

License

Copyright by SinnerSchrader. All @patternplate packages are released under the MIT license.