Code Monkey home page Code Monkey logo

patternlab-node's Introduction

Pattern Lab Logo

Build Status current release license Join the chat at Gitter

Pattern Lab Node Core

This repository contains the core functionality for Pattern Lab Node. Pattern Lab helps you and your team build thoughtful, pattern-driven user interfaces using atomic design principles.

Online Demo of Pattern Lab Output

Installation

Pattern Lab Node Core is designed to be consumed, and by default is included as a dependency within two example Node Editions.

Pattern Lab Ecosystem

Core, and Editions, are part of the Pattern Lab Ecosystem. With this architecture, we encourage people to write and maintain their own editions.

Usage

const config = require('./patternlab-config.json');
const patternlab = require('patternlab-node')(config);
patternlab.build(doneCallBack, boolCleanOutputDir);

Development Installation / Workflow

If you are interested in contributing to Pattern Lab, it's suggested to install an Edition of your choice and then run a local copy of this repository via npm link.

mkdir /patternlab-node
cd /patternlab-node
git clone https://github.com/pattern-lab/patternlab-node.git
npm install
npm link
cd location/of/edition
npm link patternlab-node

The above is a bit verbose, but illustrates:

  1. how to clone this repository to an arbitrary location
  2. install all dependencies (run npm install --dev if your NODE_ENV is production for some reason)
  3. setup the npm link to your local copy
  4. use the local copy of patternlab-node in your edition

Make sure to change to whichever branch you intend to hack on or test within your cloned repository, such as dev or bugfix/fixes-broken-unittest

Upgrading

If you find yourself here and are looking to upgrade, check out how to upgrade from version to version of Pattern Lab Node here: https://github.com/pattern-lab/patternlab-node/wiki/Upgrading

View the ChangeLog for the latest Pattern Lab Node updates.

Contributing

If you'd like to contribute to Pattern Lab Node, please do so! There is always a lot of ground to cover and something for your wheelhouse.

Please read the guidelines: https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md

Core Team

Community

The Pattern Lab Node team uses our gitter.im channel, pattern-lab/node to keep in sync, share updates, and talk shop. Please stop by to say hello or as a first place to turn if stuck. Other channels in the Pattern Lab organization can be found on gitter too.

There is also a dedicated Pattern Lab channel on the design system slack run by @jina.

Ask or answer Pattern Lab questions on Stack Overflow: http://stackoverflow.com/questions/tagged/patternlab.io

Support Pattern Lab Node

Pattern Lab Node is on Patreon account to allow users and organizations to directly support continued work on the Pattern Lab Node project.

I (Brian talking) need help and support to make Pattern Lab Node a sustained success. I devote a lot of free time and would-be sleep to make the project what it is, but nothing compares to hearing back from users. It means the world to me when people find value in Pattern Lab Node. I am ridiculously humbled to hear and see what you all build with it.

If you find yourself here and balk and the idea of supporting open source software monetarily - I understand. Carry on, but please do share what you build - we all learn more together.

License

MIT

patternlab-node's People

Contributors

alexbenic avatar andrewleedham avatar bmuenzenmeyer avatar bramsmulders avatar colynb avatar e2tha-e avatar evanlovely avatar gael-boyenval avatar geoffp avatar getsetbro avatar giuseppepaul avatar ivanmayes avatar jeremykenedy avatar johngerome avatar kyleknighted avatar kylewelsby avatar marcinmodestowicz avatar nilshartmann avatar patternfly-build avatar raphaelokon avatar scottgruber avatar scottnath avatar spezzino avatar stevedesmond-ca avatar tannerhodges avatar teehemkay avatar tevio avatar torbs avatar walmokrani avatar zacanger avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.