Giter Club home page Giter Club logo

pw-uikit's Introduction

Planswell UIKit

Planswell UIKit is a collection of React UI components heavily inspired by CloudFlare's React UIKit. It is constructed using Lerna to easily package many npm packages under packages for simplified development and testing. The key differences with CloudFlare's implementation are:

  • Full ES6 everywhere
  • CSS Modules support
  • Test via mocha & enzyme (same as pw-react)

Running/Building

To get the CSS working correctly you need to run npm run lerna:bootstrap

Development

The development environment is React Storybook. Run npm start to launch React Storybook and you'll see composed stories there. Add a new story to an existing component for new behaviours or add new story files for new components. See React Storybook for more.

Publishing

npm login npm run lerna:publish

Helper Scripts

Helper scripts live in the helpers directory. These are simple little scripts registered in package.json to ease the development process. They should be simple and easy to understand, and if you can think of a task that could be automated, feel free to write a helper script for it. Scripts are run with npm run scriptname [arguments...]

  • g:component new-name: "generate component"; creates a file tree for a new component with the given name

Testing

Testing is done within each component by leveraging the webpack configuration with internals/. The entire testing setup mirrors our pw-react project. Simply run the same scripts to test (such as npm test and npm run test:watch).

Future Enhancement

  • PostCSS Integration

pw-uikit's People

Contributors

qstrahl avatar icolpitts avatar boxxxie avatar kenips avatar itsdynamike avatar corvillus avatar maedhr avatar olafura avatar olafurara avatar

Watchers

Robert Peacock avatar James Cloos avatar  avatar  avatar  avatar

pw-uikit's Issues

font awesome is not working

font magician is not writing rules for bringing down font awesome.
i think it's related to the fontawrsome plugin.

specifically i think it's the order of execution of fontawesome plugin being run after fontmagician because font magician is most likely looking for "font-family" in css, and the font awesome plugin means that css isn't written yet.

look at lines 57 & 58 in .storybook/webpack.config.js

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.