lcdl-lib

la-casa-del-libro

Description

UI component library project developed with Svelte 4, using Vite as the bundler and Storybook 8 for component documentation and visualization.

Available Scripts

• npm run dev
  Starts the development server using Vite.

• npm run build
  Builds the project for production.

• npm run check
  Runs svelte-check to verify code and types with TypeScript.

• npm run test
  Placeholder script for tests. No tests defined yet.

• npm run storybook
  Starts Storybook in development mode to document and visually test components.

• npm run build-storybook
  Builds the static production version of Storybook.

• npm run types
  Compiles TypeScript types (runs tsc).

• npm run build:lib
  Runs type compilation and production build (combines types and build).

Project Configuration

• Main entry: ./dist/index.js
• ES module: ./dist/index.js
• Type definitions: ./dist/index.d.ts
• Svelte entry point: ./src/index.ts

Main Dependencies and DevDependencies

• Svelte 4
• Vite (bundler and dev server)
• Storybook 8 for Svelte with essential addons
• TypeScript with Svelte-specific configuration
• Sass for styles
• Prettier and prettier-plugin-svelte for code formatting
• Autoprefixer and postcss-load-config for CSS processing
• Vitest for testing (tests not configured yet)
• Playwright for e2e testing (tests not configured yet)

Notes

• The project uses ES Modules ("type": "module" in package.json).
• CSS processing uses PostCSS with Autoprefixer.
• Storybook is configured to work with Vite and Svelte.
• Components are distributed in the dist folder with support for types and ES modules.

How to Contribute

• Clone the repository.
• Run npm install to install dependencies.
• Use npm run dev for local development.
• Use npm run storybook to work with components visually.
• Before pushing changes, run npm run check to verify types.
• Add tests and documentation in Storybook for new components.

License

ISC

Author

Not specified