portal-bits

A Svelte component library built around a measured visual language and reusable interface patterns.

Status

Active

What it does

Run the gallery to inspect the components, foundations, and motion. Pushes to main publish that gallery to GitHub Pages. Install portal-bits from the public npm registry. The install steps are in docs/guides/install-the-library.md. The deploy steps are in docs/guides/deploy-the-gallery.md.

Quick start

npm install
npm run dev

Vite serves the gallery on 127.0.0.1.

Project structure

• src/ holds the library and the gallery.
• docs/ holds the documentation.
• tests/ holds the Vitest tests.
• static/ holds gallery images.
• scripts/ holds package checks. The consumer script is not in the repo yet.
• .github/ holds issue forms, the pull request template, and the package and gallery workflows.

Development

npm run dev runs the gallery. npm test, npm run check, and npm run format:check are the day-to-day checks.

Documentation

The map of the docs is docs/README.md. Start with the glossary, the architecture, and how to run the gallery.

License

MIT