Template Svelte screenshot

Template Svelte

Author Avatar Theme by Metonym
Updated: 15 Jan 2022
9 Stars

Template for building Svelte component libraries with Storybook, Rollup and Jest.

Overview

The Svelte Library Template is a robust starting point for developers looking to create their own libraries using Svelte. This template integrates seamlessly with Storybook and Rollup, providing a strong foundation for building, documenting, and testing your library. With a focus on best practices, it ensures a smooth development experience while maintaining high-quality standards.

This template not only sets the stage for efficient development but also simplifies the process of publishing your library to npm. Whether you’re a seasoned developer or just starting out, the built-in scripts and configurations help streamline your workflow, making it easier to deliver a polished final product.

Features

  • Storybook Integration: Easily run Storybook in development mode to visualize and interact with your components locally.

  • Unit Testing with Jest: Use Jest alongside @testing-library/svelte for rigorous unit testing, ensuring your components work as expected.

  • Automated Code Formatting: Keep your code clean and consistent with Prettier and prettier-plugin-svelte for automatic formatting.

  • ESLint Support: Catch common issues early with ESLint and eslint-plugin-svelte3, promoting best coding practices throughout your project.

  • Continuous Integration: Leverage Travis CI to automatically test your library on every code commit, enhancing collaboration and reliability.

  • Production Build with Rollup: Easily build your library for production with Rollup, outputting optimized artifacts to the designated lib folder.

  • Publishing Made Simple: Follow a straightforward process to update library metadata and publish to npm, ensuring your library is easily accessible to others.

  • Documentation Generation: Automatically build and host documentation using GitHub Pages through the Storybook setup, making it easy for users to understand your library’s functionality.