Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/natterstefan/react-component-library-lerna
Build your own React component library managed with lerna, presented with storybook and published in private npm registry.
https://github.com/natterstefan/react-component-library-lerna
component-library css-js eslint example-repo jest lernajs monorepo prettier reactjs remark-lint storybook styled-components stylelint
Last synced: about 2 months ago
JSON representation
Build your own React component library managed with lerna, presented with storybook and published in private npm registry.
- Host: GitHub
- URL: https://github.com/natterstefan/react-component-library-lerna
- Owner: natterstefan
- License: apache-2.0
- Created: 2019-02-02T18:58:24.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-25T21:17:34.000Z (10 months ago)
- Last Synced: 2024-05-02T02:05:13.928Z (8 months ago)
- Topics: component-library, css-js, eslint, example-repo, jest, lernajs, monorepo, prettier, reactjs, remark-lint, storybook, styled-components, stylelint
- Language: JavaScript
- Homepage:
- Size: 895 KB
- Stars: 60
- Watchers: 4
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# React Component Library with Lerna
[](https://github.com/natterstefan/react-component-library-lerna/blob/master/package.json)
[](https://github.com/natterstefan/react-component-library-lerna/blob/master/package.json)
[](https://snyk.io/test/github/natterstefan/react-component-library-lerna)
[](https://github.com/natterstefan/react-component-library-lerna/blob/master/LICENCE)
[](http://makeapullrequest.com)
Build your own React component library managed with lerna and presented with
storybook.
## Features
- [react-hooks](https://reactjs.org/docs/hooks-overview.html) support ⚛
- integrated [storybook@5](https://storybook.js.org) with examples :books:
- example components built with [styled-components](https://github.com/styled-components/styled-components) 💅
- [ESLint](https://github.com/eslint/eslint), [stylelint](https://github.com/stylelint/stylelint)
and [remark](https://github.com/remarkjs/remark) and [prettier](https://github.com/prettier/prettier)
integration
- [jest](https://github.com/facebook/jest) 🃏 and [enzyme](https://github.com/airbnb/enzyme)
for testing
- [built-in cli]: create new component packages within seconds (`yarn commander --help`)
## Getting started
Use `yarn` instead of `npm`, because we rely on [`yarn`'s `workspaces` feature](https://yarnpkg.com/lang/en/docs/workspaces/).
```bash
yarn
yarn bootstrap
yarn start
```
Now you can open storybook at [http://localhost:9001](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](https://verdaccio.org/)),
- and finally how to create a docker image with an example app.
Stay tuned!
### How to add new dependencies
Adding `devDependencies` looks like this:
```sh
yarn add --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:
```sh
npx lerna add
```
One can read more about the command (eg. how to scope it, etc.) [here](https://github.com/lerna/lerna/tree/master/commands/add).
### How to test publishing
This repository comes with a pre-configured [verdaccio](https://verdaccio.org/)
(private npm registry) setup. All you need to do is start it with:
```bash
cd localdev
docker-compose -d # will start the verdaccio docker image
```
Now, open [http://localhost:4873/](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](./.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](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](LICENCE)
## Maintainers
