Spirit Design System

Spirit is an open-source design system developed by Alma Career (formerly LMC).

Getting Started

See individual packages to learn how to get started.

Packages

Package name	Description	Version
@alma-oss/spirit-analytics	Analytic tools for Spirit Design System
@alma-oss/spirit-codemods	Codemod transforms for Spirit Design System version migration
@alma-oss/spirit-common	Common scripts for Spirit Design System	Private
@alma-oss/spirit-design-tokens	Design tokens for Spirit Design System
@alma-oss/spirit-icons	Icons for Spirit Design System
@alma-oss/spirit-web	CSS and vanilla JS implementation of Spirit Design System
@alma-oss/spirit-web-react	React implementation of Spirit Design System components

Packages Before 🌈 Divine Release (v4)

lmc-eu Scope Packages

Package name	Description	Version
@lmc-eu/spirit-analytics	Analytic tools for Spirit Design System
@lmc-eu/spirit-codemods	Codemod transforms for Spirit Design System version migration
@lmc-eu/spirit-common	Common scripts for Spirit Design System	Private
@lmc-eu/spirit-design-tokens	Design tokens for Spirit Design System
@lmc-eu/spirit-form-validations	Form Validations for Spirit Design System
@lmc-eu/spirit-icons	Icons for Spirit Design System
@lmc-eu/spirit-web	CSS and vanilla JS implementation of Spirit Design System
@lmc-eu/spirit-web-react	React implementation of Spirit Design System components
@lmc-eu/spirit-web-twig	Twig implementation of Spirit Design System components

Development

Prerequisites

• NodeJS
• Corepack
• Yarn
• Lerna

🚀 Start Development

• git clone ssh://[email protected]:lmc-eu/spirit-design-system.git
• cd spirit-design-system
• corepack enable
• corepack install
• yarn install
• yarn start

See package.json for all available tasks.

🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide! 👀

📝 License

See the LICENSE file for information.