node package manager

progressive-web-sdk

A set of libraries and components which make up the SDK for Progressive Web

 (                                                                              (    (         )  
 )\ )                                                   (  (               )    )\ ) )\ )   ( /(  
(()/( (         (  (  (      (         (    )      (    )\))(   '   (   ( /(   (()/((()/(   )\())
 /(_)))(    (   )\))( )(    ))\ (   (  )\  /((    ))\  ((_)()\ )   ))\  )\())   /(_))/(_))|((_)\  
(_)) (()\   )\ ((_))\(()\  /((_))\  )\((_)(_))\  /((_) _(())\_)() /((_)((_)\   (_)) (_))_ |_ ((_)
| _ \ ((_) ((_) (()(_)((_)(_)) ((_)((_)(_)_)((_)(_))   \ \((_)/ /(_))  | |(_)  / __| |   \| |/ /  
|  _/| '_|/ _ \/ _` || '_|/ -_)(_-<(_-<| |\ V / / -_)   \ \/\/ / / -_) | '_ \  \__ \ | |) | ' <   
|_|  |_|  \___/\__, ||_|  \___|/__//__/|_| \_/  \___|    \_/\_/  \___| |_.__/  |___/ |___/ _|\_\  
               |___/                                                                              

NPM CircleCI

A set of components and utilities which make up the SDK for Progressive Web

You can find the live version of the SDK Docs here

Requirements

  • Git
  • We recommend you use nvm to manage node and npm versions.
  • Node ^6.9.x LTS
  • npm ^3.10.8

Install Dependencies

npm i

Usage

The Progressive Web SDK has a number of components that can be used in progressive web builds. Component documentation and examples can be seen by running our styleguide:

npm run docs:dev

You can now view the styleguide at http://localhost:9000.

Our docs are built on styleguidist.

Use the SDK in a project

To use the progressive-web-sdk in a project, add it as a dev-dependency to your package.json. Once you have done that, run npm install.

Components can now be imported into your project by loading the build files from dist:

import Button from 'progressive-web-sdk/dist/components/button'
 
const myButton = <Button text="Take My Money!" />

If you are actively developing a new library or component in the SDK, run the following command in order for the files to be built into dist when making changes in src:

npm run dev:watch

Adding a Component

First read our contributing guidelines.

To create a component, run:

npm run add:component