trycereal-kits

React Component Library with Lerna

Build your own React component library managed with lerna and presented with storybook.

Features

• react-hooks support ⚛
• integrated storybook@5 with examples 📚
• example components built with styled-components 💅
• ESLint, stylelint and remark and prettier integration
• jest 🃏 and enzyme for testing

Getting started

Use yarn instead of npm, because we rely on yarn's workspaces feature.

yarn
yarn bootstrap
yarn start

Now you can open storybook at http://localhost:9001.

Docs

Please, be patient. I will soon add "How to" sections. They are going to tell you:

• how to use this example component library for your own projects,
• some things I learned about lerna and monorepos (eg. yarn workspaces are pretty neat),
• how to use storybook (eg. creating stories, ...),
• how to publish packages to your private npm registry (eg. with verdaccio),
• and finally how to create a docker image with an example app.

Stay tuned!

How to add new dependencies

Adding devDependencies looks like this:

yarn add <package-name> --dev -W

This will add the dependency too the root package.json and make it available to all packages.

Adding a new dependency for all or one of the packages looks like this:

npx lerna add <package-name>

One can read more about the command (eg. how to scope it, etc.) here.

How to test publishing

This repository comes with a pre-configured verdaccio (private npm registry) setup. All you need to do is start it with:

cd localdev
docker-compose -d # will start the verdaccio docker image 

Now, open http://localhost:4873/. You should see the UI of verdaccio on your screen now. That's great. Because it means you can now publish the packages to this npm registry. Usually you have to login to the registry, but the .npmrc already includes the _authToken. So yarn publish in one of the packages will publish it, or with yarn publish in the root folder (uses lerna).

In order to publish your packages to npm, simply change the registry property in each package.json's publishConfig.

Contribution

PRs are welcome and I am happy if you want to contribute! Just let me know, please.

Forks

If this repository is forked and I see further progress on the forked repo, I am very happy to list your work here. It's awesome to see, when people start using and moving this repository even further.

• https://github.com/sebastianescribano/react-component-library-lerna: they are really pushing it. They integrated a CLI to create packages from a template, for instance.

Licence

Apache 2.0

Maintainers

Stefan Natter