Skip to content
Build your own React component library managed with lerna, presented with storybook and published in private npm registry.
JavaScript HTML
Branch: master
Clone or download
Latest commit 8be411b Mar 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github jest setup, verdaccio docker setup and readme Feb 9, 2019
.storybook Template CLI (#2) Mar 20, 2019
localdev jest setup, verdaccio docker setup and readme Feb 9, 2019
packages style card and button with new theme package Feb 15, 2019
scripts Template CLI (#2) Mar 20, 2019
templates/component Template CLI (#2) Mar 20, 2019
.babelrc jest setup, verdaccio docker setup and readme Feb 9, 2019
.eslintignore added build logic (es, umd, ...) and optimised bundling Feb 11, 2019
.eslintrc.js jest setup, verdaccio docker setup and readme Feb 9, 2019
.gitignore added build logic (es, umd, ...) and optimised bundling Feb 11, 2019
.npmrc updated packages, upgraded storybook@4 -> storybook@5 Mar 8, 2019
.nvmrc initial commit Feb 2, 2019
.prettierignore initial commit Feb 2, 2019
.prettierrc initial commit Feb 2, 2019
.remarkignore added remark (linter for .md files) Feb 10, 2019
.remarkrc added remark (linter for .md files) Feb 10, 2019
.stylelintrc added styled-components, fixed jest setup (unresolved imports) Feb 10, 2019
CHANGES.md Template CLI (#2) Mar 20, 2019
CONTRIBUTING.md added remark (linter for .md files) Feb 10, 2019
LICENCE update readme Mar 9, 2019
README.md Template CLI (#2) Mar 20, 2019
babel.config.js added build logic (es, umd, ...) and optimised bundling Feb 11, 2019
jest.config.js added styled-components, fixed jest setup (unresolved imports) Feb 10, 2019
jest.setup.js jest setup, verdaccio docker setup and readme Feb 9, 2019
lerna.json jest setup, verdaccio docker setup and readme Feb 9, 2019
package.json Template CLI (#2) Mar 20, 2019
webpack.config.js added build logic (es, umd, ...) and optimised bundling Feb 11, 2019
yarn.lock Template CLI (#2) Mar 20, 2019

README.md

React Component Library with Lerna

Dependencies DevDependencies Known Vulnerabilities GitHub license PRs Welcome

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

Features

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.

Licence

Apache 2.0

Maintainers


Stefan Natter
You can’t perform that action at this time.