https://github.com/storyblok-components/components

Monorepo with @storyblok-components core features and all available components.
https://github.com/storyblok-components/components

amazingness gatsby javascript lerna monorepo nextjs storyblok storyblok-components

Last synced: about 2 months ago
JSON representation

Monorepo with @storyblok-components core features and all available components.

• Host: GitHub
• URL: https://github.com/storyblok-components/components
• Owner: storyblok-components
• Created: 2020-04-24T16:32:12.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-03T06:17:13.000Z (almost 2 years ago)
• Last Synced: 2024-11-14T21:35:19.085Z (2 months ago)
• Topics: amazingness, gatsby, javascript, lerna, monorepo, nextjs, storyblok, storyblok-components
• Language: JavaScript
• Homepage:
• Size: 2.72 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 29
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    



[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)

If you've found an issue or you have feature request - open an issue or look if it was already created.

## Contents

- [How to contribute](#how-to-contribute)

  - [Roadmap](#roadmap)

---

# How to contribute

1. Clone repository:

```

git clone [email protected]:storyblok-components/components.git

```

2. Install dependencies by running `yarn`

3. Install `sb-mig` CLI globally

```

npm install --global sb-mig@latest

```

4. Install `create-component` plugin for `sb-mig`

```

sb-mig plugin:install create-component

```

5. Run

```

sb-mig create-component name-of-the-component

```

6. It will create folder `name-of-the-component` inside `@storyblok-components` folder. Content of the folder: 

```

content

...

```

---

1. When React and Storyblok Schema part are created, and ready to release:

- a. `git checkout -b name-of-branch` to create branch

- a. run `git commit -m ""`

- b. it will prompt couple question to be compliant with conventional commits rules

- c. 

```

git push

```

- d. wait for code review

---

After successfull code review and merge to master, it will be automatically build and deploy to npm. You can install your new component in other projects like:

```

npm install @storyblok-components/name-of-the-component

```

or with yarn

```

yarn add @storyblok-components/name-of-the-component

```

## Roadmap

- [ ] ?

## Contibutors

- Special thanks to Pedro Sousa for lerna magic.