@dailybruin/lux

    1.15.0 • Public • Published

    Lux

    npm Build Status codecov dependencies Status devDependencies Status code style: prettier tested with jest Commitizen friendly license

    Lux is a design system for the Daily Bruin, written in TypeScript and React.

    You may also be interested in projects that use Lux, which include our gatsby starter and dailybruin.com's frontend.

    Usage

    To use Lux, simply install it with your favorite package manager, e.g.:

    yarn add @dailybruin/lux
    

    Import components with the following syntax:

    import { Article } from '@dailybruin/lux'

    Note that Lux is published as TypeScript files, and thus is only available to projects that use TypeScript and some kind of build system (e.g., Webpack). If you run into errors setting Lux up with your project, please file an issue.

    Development

    To start a dev server for the docs:

    yarn start
    

    To test:

    yarn test
    

    Deployment

    Lux is autopublished to npm by Travis with semantic-release and travis build stages. Tokens were set up with semantic-release-cli (semantic-release-cli setup), using dailybruin-bot's npm and GitHub credentials.

    yarn publish
    

    To build the docs:

    yarn build:docs
    

    Install

    npm i @dailybruin/lux

    DownloadsWeekly Downloads

    271

    Version

    1.15.0

    License

    AGPL-3.0

    Unpacked Size

    1.55 MB

    Total Files

    123

    Last publish

    Collaborators

    • dailybruin-bot
    • dustinnewman98
    • nathunsmitty
    • ryang72