https://github.com/artursopelnik/lit-storybook-boilerplate

A boilerplate template for creating fast and robust design systems ✨ with Lit, Storybook, Vite and TypeScript
https://github.com/artursopelnik/lit-storybook-boilerplate

lit storybook webcomponents

Last synced: 22 days ago
JSON representation

A boilerplate template for creating fast and robust design systems ✨ with Lit, Storybook, Vite and TypeScript

• Host: GitHub
• URL: https://github.com/artursopelnik/lit-storybook-boilerplate
• Owner: artursopelnik
• License: mit
• Created: 2024-11-06T12:06:51.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-18T22:05:33.000Z (3 months ago)
• Last Synced: 2024-11-18T22:55:13.000Z (3 months ago)
• Topics: lit, storybook, webcomponents
• Language: TypeScript
• Homepage: https://artursopelnik.github.io/lit-storybook-boilerplate/?path=/docs/configure-your-project--docs
• Size: 1000 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lit-storybook-boilerplate

*A boilerplate template for creating fast and robust design systems for React, Remix, Next.js, Vue, Angular or Vanilla JS Application ✨ with Lit and Storybook.*

Monorepo setup with *Lerna*.

Note: Angular plays nice with custom elements, so you can use Lit in your Angular apps.

## 💡 Requirements

- Node.js 20

- Git

## 🚀 Setup

1. Select the compatible Node version: `nvm use`

2. Install dependencies: `npm install`

3. Navigate to the core package: `cd /packages/lit` and build it with: `npm run build`

4. Go to the Storybook package: `cd /packages/storybook`

    - Use `npm run storybook` to watch for changes in Storybook.

## 👏 Contributing

- :octocat: [Pull requests](https://github.com/artursopelnik/lit-storybook-boilerplate/pulls) and 🌟 stars are always welcome.

- For major changes, please open an [issue](https://github.com/artursopelnik/lit-storybook-boilerplate/issues) first to discuss what you would like to change.

- Please make sure to update tests as appropriate.

## 📩 Contact

📧 [email protected]

💼 Linkedin [@artursopelnik](https://www.linkedin.com/in/artur-sopelnik-b93656110/)

## License

MIT © [Artur Sopelnik](https://github.com/artursopelnik/)