@patternplate/client
Universal javascript client application for patternplate
Last updated 3 months ago by marionebl .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install @patternplate/client 
SYNC missed versions from official npm registry.

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.

Current Tags

  • 3.0.7-1                                ...           canary (4 months ago)
  • 3.2.5                                ...           latest (3 months ago)
  • 2.0.0-4                                ...           next (a year ago)
  • 2.6.2-0                                ...           testing (6 months ago)

146 Versions

  • 3.2.5                                ...           3 months ago
  • 3.2.4                                ...           4 months ago
  • 3.2.3                                ...           4 months ago
  • 3.2.2                                ...           4 months ago
  • 3.2.0                                ...           4 months ago
  • 3.1.1                                ...           4 months ago
  • 3.0.7-1                                ...           4 months ago
  • 3.0.7-0                                ...           4 months ago
  • 3.0.6                                ...           4 months ago
  • 3.0.4                                ...           6 months ago
  • 3.0.3                                ...           6 months ago
  • 3.0.2                                ...           6 months ago
  • 3.0.1                                ...           6 months ago
  • 3.0.0                                ...           6 months ago
  • 2.6.2-0                                ...           6 months ago
  • 2.6.1-0                                ...           6 months ago
  • 2.6.0-0                                ...           6 months ago
  • 2.6.0-alpha.38464754                                ...           6 months ago
  • 2.6.0-alpha.154b7b63                                ...           6 months ago
  • 2.5.25                                ...           7 months ago
  • 2.5.24                                ...           7 months ago
  • 2.5.23                                ...           7 months ago
  • 2.5.21                                ...           9 months ago
  • 2.5.19                                ...           9 months ago
  • 2.5.18                                ...           9 months ago
  • 2.5.15                                ...           9 months ago
  • 2.5.13                                ...           10 months ago
  • 2.5.12                                ...           10 months ago
  • 2.5.11                                ...           10 months ago
  • 2.5.10                                ...           10 months ago
  • 2.5.9                                ...           10 months ago
  • 2.5.8                                ...           10 months ago
  • 2.5.7                                ...           10 months ago
  • 2.5.6                                ...           10 months ago
  • 2.5.5                                ...           10 months ago
  • 2.5.4                                ...           a year ago
  • 2.5.3                                ...           a year ago
  • 2.5.2                                ...           a year ago
  • 2.5.1                                ...           a year ago
  • 2.4.1                                ...           a year ago
  • 2.4.0                                ...           a year ago
  • 2.3.3                                ...           a year ago
  • 2.3.2                                ...           a year ago
  • 2.3.1                                ...           a year ago
  • 2.3.0                                ...           a year ago
  • 2.2.0                                ...           a year ago
  • 2.1.6                                ...           a year ago
  • 2.1.5                                ...           a year ago
  • 2.1.4                                ...           a year ago
  • 2.1.3                                ...           a year ago
  • 2.1.2                                ...           a year ago
  • 2.1.1                                ...           a year ago
  • 2.0.16                                ...           a year ago
  • 2.0.15                                ...           a year ago
  • 2.0.14                                ...           a year ago
  • 2.0.13                                ...           a year ago
  • 2.0.12                                ...           a year ago
  • 2.0.10                                ...           a year ago
  • 2.0.8                                ...           a year ago
  • 2.0.5                                ...           a year ago
  • 2.0.4                                ...           a year ago
  • 2.0.3                                ...           a year ago
  • 2.0.2                                ...           a year ago
  • 2.0.1                                ...           a year ago
  • 2.0.0                                ...           a year ago
  • 2.0.0-93                                ...           a year ago
  • 2.0.0-92                                ...           a year ago
  • 2.0.0-91                                ...           a year ago
  • 2.0.0-90                                ...           a year ago
  • 2.0.0-88                                ...           a year ago
  • 2.0.0-87                                ...           a year ago
  • 2.0.0-86                                ...           a year ago
  • 2.0.0-85                                ...           a year ago
  • 2.0.0-84                                ...           a year ago
  • 2.0.0-83                                ...           a year ago
  • 2.0.0-82                                ...           a year ago
  • 2.0.0-81                                ...           a year ago
  • 2.0.0-80                                ...           a year ago
  • 2.0.0-79                                ...           a year ago
  • 2.0.0-78                                ...           a year ago
  • 2.0.0-77                                ...           a year ago
  • 2.0.0-76                                ...           a year ago
  • 2.0.0-75                                ...           a year ago
  • 2.0.0-74                                ...           a year ago
  • 2.0.0-73                                ...           a year ago
  • 2.0.0-72                                ...           a year ago
  • 2.0.0-71                                ...           a year ago
  • 2.0.0-70                                ...           a year ago
  • 2.0.0-69                                ...           a year ago
  • 2.0.0-68                                ...           a year ago
  • 2.0.0-67                                ...           a year ago
  • 2.0.0-66                                ...           a year ago
  • 2.0.0-65                                ...           a year ago
  • 2.0.0-63                                ...           a year ago
  • 2.0.0-62                                ...           a year ago
  • 2.0.0-61                                ...           a year ago
  • 2.0.0-60                                ...           a year ago
  • 2.0.0-59                                ...           a year ago
  • 2.0.0-58                                ...           a year ago
  • 2.0.0-57                                ...           a year ago
  • 2.0.0-56                                ...           a year ago
  • 2.0.0-55                                ...           a year ago
  • 2.0.0-54                                ...           a year ago
  • 2.0.0-53                                ...           a year ago
  • 2.0.0-52                                ...           a year ago
  • 2.0.0-51                                ...           a year ago
  • 2.0.0-50                                ...           a year ago
  • 2.0.0-49                                ...           a year ago
  • 2.0.0-48                                ...           a year ago
  • 2.0.0-47                                ...           a year ago
  • 2.0.0-46                                ...           a year ago
  • 2.0.0-45                                ...           a year ago
  • 2.0.0-44                                ...           a year ago
  • 2.0.0-43                                ...           a year ago
  • 2.0.0-42                                ...           a year ago
  • 2.0.0-41                                ...           a year ago
  • 2.0.0-40                                ...           a year ago
  • 2.0.0-39                                ...           a year ago
  • 2.0.0-38                                ...           a year ago
  • 2.0.0-y.0                                ...           a year ago
  • 2.0.0-37                                ...           a year ago
  • 2.0.0-36                                ...           a year ago
  • 2.0.0-35                                ...           a year ago
  • 2.0.0-34                                ...           a year ago
  • 2.0.0-33                                ...           a year ago
  • 2.0.0-32                                ...           a year ago
  • 2.0.0-31                                ...           a year ago
  • 2.0.0-30                                ...           a year ago
  • 2.0.0-29                                ...           a year ago
  • 2.0.0-28                                ...           a year ago
  • 2.0.0-27                                ...           a year ago
  • 2.0.0-2.0.0-26.debug.0                                ...           a year ago
  • 2.0.0-24                                ...           a year ago
  • 2.0.0-23                                ...           a year ago
  • 2.0.0-22                                ...           a year ago
  • 2.0.0-21                                ...           a year ago
  • 2.0.0-19                                ...           a year ago
  • 2.0.0-16                                ...           a year ago
  • 2.0.0-14                                ...           a year ago
  • 2.0.0-12                                ...           a year ago
  • 2.0.0-11                                ...           a year ago
  • 2.0.0-9                                ...           a year ago
  • 2.0.0-5                                ...           a year ago
  • 2.0.0-4                                ...           a year ago
  • 2.0.0-3                                ...           a year ago
  • 2.0.0-0                                ...           a year ago
Downloads
Today 0
This Week 0
This Month 150
Last Day 0
Last Week 146
Last Month 585
Dependencies (13)
Dev Dependencies (47)

Copyright 2014 - 2016 © taobao.org |