Skip to content

lucidds/lucid-components

Repository files navigation

MUI logo

Lucid Design System - Components 🔷

Lucid Design System is a modular and reusable design system, built with Web Components and optimized for React, Vue, and Angular.

license

Index

How to use

Lucid DS is available as an npm package.

Web Components

Lucid DS is available as an npm package.

npm:

npm install ----

yarn:

yarn add ----

Angular

Lucid DS is available as an angular npm package.

npm:

npm install ----

yarn:

yarn add ----

React

Lucid DS is available as an react npm package.

npm:

npm install ----

yarn:

yarn add ----

Vue

Lucid DS is available as an vue npm package.

npm:

npm install ----

yarn:

yarn add ----

Project Structure

The project is organized into a monorepo using Lerna and Yarn Workspaces. Here is the project structure:

/lucid-design-system
../packages
..../core
....../components
....../tokens
....../utils
..../react
....../components
..../vue
....../components
..../angular
....../components
../docs

Installation

To install all project dependencies, run:

yarn install

Development

To start developing, navigate into the package you want to work on and start your local development environment.

For example, to start working on the core package:

cd packages/core
yarn start

Documentation

The project's documentation can be found in the /docs folder.

Contributing

We are always open to contributions. Please read our contribution guide for more information.

License

This project is licensed under the MIT Licens.

Releases

No releases published

Packages

No packages published