Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@patternplate/client

Package Overview
Dependencies
Maintainers
5
Versions
153
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@patternplate/client

Universal javascript client application for patternplate

  • 3.2.5
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
5
Created
Source

Documentation and development interface for component libraries

@patternplate/client

  • 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/client

@patternplate/client is a universally rendering application that provides the GUI available at http://localhost:1337 when executing patternplate start.

The client entry point is src/client, the server entry point src/server.

@patternplate/client also provides means to export required client assets statically.

@patternplate/client interfaces with @patternplate/api to fetch data and uses fronted compenents @patternplate/components.

Quick start

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

Usage

Use the express middleware

const client = require("@patternplate/client");

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

  const clientMiddleware = await client({
    cwd: options.cwd,
    config: options.config,
    server
  });

  app.use(clientMiddleware);
})();

Render a page

const render = require("@patternplate/client/render");

(async () => {
  const html = await render("/", {
    base: "" // base url to assume, e.g. patternplate in https://git.io/patternplate,
    config: {},
    schema: {
      meta: {}, // pattern tree, see @patternplate/load-meta 
      docs: {} // pattern docs, see @patternplate/load-docs 
    },
    isStatic: 
  });
})();

Eject a virtual fs with static assets

const eject = require("@patternplate/client/eject");

(async () => {
  const vfs = await eject(); // MemoryFilesystem({ /static/, /lib/ });
})();

License

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

Keywords

FAQs

Package last updated on 06 Jan 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc