Skip to content

cap-collectif/ui

Repository files navigation

CapUI


Design system for Cap Collectif

npm version Tested with Chromatic npm bundle size

📦 Install

npm i @cap-collectif/ui
...
yarn add @cap-collectif/ui

🔨 Usage

import { Button, Heading } from '@cap-collectif/ui';

const App = () => (
  <>
    <Heading as="h1">Title</Heading>
    <Button variant="primary">PRESS ME</Button>
  </>
);

🔗 Documentation

👉 Read the Storybook stories

📝 View the Changelog

💻 Development

$ git clone https://github.com/cap-collectif/ui.git
$ cd ui/
$ yarn
$ yarn storybook

The browser will launch automatically to http://localhost:6006

🤝 Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request 😊

📄 License

License