legitmaxwu / lux

Lux is a design system for the Daily Bruin.

Lux

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-deploy-once. Tokens were set up with semantic-release-cli (semantic-release-cli setup), using Nathan's npm and GitHub credentials.

yarn publish

To build the docs:

yarn build:docs