ReactLux: Lux for React

ReactLux is an implementation of the Lumos Design Language in React

It is inspired by Lux and a couple open source libraries like Atlaskit and backpack-ui

A live version of our storybook is available here: https://s3.amazonaws.com/lumos-react-lux-storybook/%3A/index.html

Setup

1. Clone the React Lux repository. $git clone [email protected]:lumoslabs/react_lux.git
2. Install yarn
3. $yarn install
4. $yarn run storybook
5. Navigate to http://localhost:6060/ in your browser

Using Yarn Link to Test Local Changes when using react_lux as a dependency.

You can use a symbolic link to your local branch of react_lux in order to update the package and see live changes in your other applications. Just follow these steps:

1. Run yarn link in react_lux
2. Run yarn link react_lux in the repository where you are using react_lux
3. Don't remove the reference to react_lux from your package.json; the link command will take precendence
4. Make changes to your react_lux branch
5. Run yarn build in your react_lux branch's root directory
6. Changes should appear in your other repository; no refresh required if you have hot reloading
7. You will need to run yarn build for each change that you make to react_lux

Releasing

Follow this guide! If you need them, the build steps for react_lux are:

1. yarn run build
2. yarn pack

Usage

Live Docs