Skip to content

Template for a fully framework agnostic web component library using StencilJS and Docusaurus

License

Notifications You must be signed in to change notification settings

DemienDrost/component-library-demo

Repository files navigation

Project README

Design systems for front-end developers: how to build a component library that works everywhere.

This project is about building a component library for front-end developers, with a focus on creating a design system that can be used universally. The goal is to develop a set of reusable UI components that are consistent and flexible, and can be easily integrated into various front-end projects.

Description

This project focuses on building a component library for creating a design system. The aim is to provide a consistent and flexible set of reusable UI components that can be integrated into various front-end projects. The design system is designed to work everywhere, regardless of the framework or technology used.

Dependencies

This project relies heavily on a few projects in order to work. Check out the documentation of these to find out more;

Installation

To use the design system, follow the steps below:

  1. Clone the repository to your local machine.
  2. Navigate to the root of the repository.
  3. Execute the command npm install to install all monorepo dependencies.

Run docs

  1. Open the docs folder cd docs
  2. Install dependencies npm install
  3. Run docs npm run start

Run Stencil

  1. Open the core project folder cd packages/stencil-library
  2. Install dependencies npm install
  3. Run the project in dev mode npm run start

Usage

Read the blog... (Comming soon!) Or read the docs!

Contributing

Contributions to this project are always welcome. If you've found a bug or want to propose a feature, you can create an issue in the GitHub repository of this project. If you want to make changes yourself, you can submit a pull request.

License

This project is licensed under the MIT license.

About

Template for a fully framework agnostic web component library using StencilJS and Docusaurus

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published