Skip to content

README.md

Latest commit

 

History

History
133 lines (91 loc) · 2.9 KB

README.md

File metadata and controls

133 lines (91 loc) · 2.9 KB

Project Logo

A modular React monorepo providing reusable components, utilities, and hooks for building chayns-based web applications.

Table of Contents

Overview

The @chayns-components project provides a collection of reusable UI components, hooks, and utilities
for developing scalable and consistent chayns web applications.

All packages are managed in a single Lerna + TypeScript monorepo, allowing shared configuration,
centralized dependency management, and unified release workflows.

This repository serves as the foundation for all modern chayns projects.

Monorepo Structure

packages/
├── core/                # Core UI components and base utilities
├── code-highlighter/    # Syntax highlighting component
├── color-picker/        # Color picker components (HueSlider, TransparencySlider, etc.)
├── date/                # Date and time picker components
└── ...

Each package includes:

  • src/ – TypeScript source files
  • docs/ – Small code examples
  • lib/ – Compiled output
  • stories/ – Storybook files for component previews
  • package.json – Metadata and Lerna configuration

Technologies

  • React – UI library for component-based development
  • TypeScript – Static type system for reliability
  • styled-components – Scoped CSS and theming
  • Lerna – Monorepo management and versioning
  • ESLint + Prettier – Code style enforcement
  • Storybook – Component documentation and preview

Getting Started

Clone the repository:

git clone https://github.com/chayns-components/chayns-components.git
cd chayns-components

Install dependencies:

npm install

Development

To build all packages:

npm run lerna:build

To start Storybook for local component development:

npm run storybook

Contribution

Contributions are welcome.
Before opening a PR, please read the Contribution Guide
for coding standards, commit messages, and branch structure.

Guidelines

For design rules, component structure, naming conventions, and code style,
see the Development Guidelines.

These guidelines define:

  • Component folder and type organization
  • Naming conventions
  • Styling and theming rules
  • TypeScript and export standards

License

This project is licensed under the MIT License.

Maintained by the chayns-components team · Built with React, TypeScript and styled-components