Monorepo for CWDS design system
This [psuedo] fork was maintained for reasons which no longer exist. I'm archiving this repo. Please go to ca-cwds/design-system. This repo is no longer maintained. All comments below this one are potentially out of date.
This a multi-package repository. You are reading the README for the repository root.
🛑 If you are looking for @cwds/* components 🛑
Install from npm:
yarn add @cwds/componentsor if you want the latest RC:
yarn add @cwds/components@nextimport React from 'react'
import { Button } from '@cwds/components'
const App = () => (
<div>
<Button>Hello World!</Button>
</div>
)We assume that you're using a bundler (like webpack) in your app. Our packages have a cjs and an esm build target. We ship scss source files so that you are in control (e.g.; with browserlist) of which polyfills/vender-prefixes/... are written at application bundling time.
To develop in this multi-package repository, you should have
yarn>1.13.x(workspace support)node>8.11.x
Clone the repository
git clone https://github.com/ca-cwds/design-system.git && cd $_
yarnTo precompile the libs and www do
yarn buildyarn devThe Guide Site has the following value proposition:
- Reference implementation for App Developers
- Living Documentation that is deployed with the libraries
- Integrated developer experience
Start up the Guide Site:
yarn startThe Guide Site runs on
create-react-app@^2.xwith additional loaders for mdx. It's a great way to encourage writing documentation while developers are building components.
This is a good integration check for our Digital Service teams at CWDS because it runs on
rails webpacker.
To run the rails app:
cd libs/rails_app
./bin/webpack-dev-serverthen in another terminal start the rails server:
cd libs/rails_app
./bin/rails s -p 3001If you have any questions regarding the contents of this repository, please email the Office of Systems Integration at FOSS@osi.ca.gov.