Charcoal

Overview

The @charcoal-ui ― PIXIV Design System is a monorepo for the @charcoal-ui packages developed by pixiv. It includes various NPM packages for different components and utilities. To use this design system, you can refer to the documentation provided or the README of each individual package. The development server can be started on http://localhost:6006, and for the documentation site, you can run a specific command and go to http://localhost:5000.

Features

• @charcoal-ui/foundation: Styled npm version
• @charcoal-ui/icons: Styled npm version
• @charcoal-ui/icons-cli: Styled npm version
• @charcoal-ui/react: Styled npm version
• @charcoal-ui/react-sandbox: Styled npm version
• @charcoal-ui/styled: Styled npm version
• @charcoal-ui/tailwind-config: Styled npm version
• @charcoal-ui/tailwind-diff: Styled npm version
• @charcoal-ui/theme: Styled npm version
• @charcoal-ui/utils: Styled npm version

Installation

To set up the @charcoal-ui ― PIXIV Design System, follow these steps:

1. Make sure you have yarn and nodenv installed.
2. Clone the monorepo.
3. Install the dependencies using yarn.
4. Start the development server on http://localhost:6006.
5. If you want to start development for the documentation site, run a specific command and go to http://localhost:5000.

Summary

The @charcoal-ui ― PIXIV Design System is a comprehensive monorepo consisting of various NPM packages for different components and utilities. It allows developers to easily incorporate styled versions of these packages into their projects. The design system provides documentation and README files for each package, making it easy to understand and utilize the available features. By following the installation guide, developers can quickly set up the development environment and start using the @charcoal-ui packages.