Skip to content

SolutionQuadrant/plasma

 
 

Repository files navigation

PLASMA by WeWork

Plasma is a design system for creating sensible, modern interfaces.

https://weconnect.github.io/plasma/docs


Developing locally

  1. Run yarn start from the root directory.
  2. Server is now running. Component docs at http://localhost:8080/plasma/docs. Playgrounds at http://localhost:8080/plasma/playground3

Publishing to NPM

  1. Bump version number in package.json as necessary.
  2. Make sure you're logged in to NPM via npm login.
  3. Run yarn publish from the root directory.
  4. Check https://www.npmjs.com/~wework-dev to make sure package is updated.

Using Plasma

  1. Run yarn add @wework-dev/plasma in your project.

  2. Link to correct version of CSS in your HTML . Example:

    <link rel="stylesheet" href="https://npmcdn.com/@wework-dev/[email protected]/style.css">
  3. Include the Plasma object (or individual components) in your Javascript. Plasma object example:

    import Plasma from '@wework-dev/plasma';
    <Plasma.Button label='Click it'/>

    Individual components example:

    import { Button } from '@wework-dev/plasma';
    <Button label='Click it'/>
  1. Run the Plasma dev server: yarn start
  2. Run the Storybook server: yarn storybook
  3. Go to http://localhost:6006/ to view the Storybook
  4. Add stories to the stories/ directory as you build/modify components!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • JavaScript 72.5%
  • CSS 27.3%
  • Other 0.2%