README
corgi-component-library
A reusable, extendable and scalable React component library
Getting started
Install corgi-component-library
yarn add corgi-component-library
Import the component that you'd line to use into your file. See example below:
import { Text } from "corgi-component-library";
For the full list of our components and to read the relevant Documentations please visit our Storybook
Development
Project development how-tos
// Installing dependencies:
yarn
// Building the project
yarn build
// Running the tests
yarn test
// To run the build script in watch mode
yarn build:watch
// Running Storybook
yarn storybook
// Building Storybook
yarn storybook:build
// Running react-cosmos
yarn cosmos
// Building react-cosmos
yarn cosmos:build
// Linting the application
yarn lint
// Running the prettier formater
yarn prettier
Built With
Browser support
Latest version of most popular browsers. Specific version numbers to be determined soon.
How to contribute
Please see our CONTRIBUTING readme
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Changelog
For the full changelog please see our changelog
Authors
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE file for details