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:
- Make sure you have yarn and nodenv installed.
- Clone the monorepo.
- Install the dependencies using yarn.
- Start the development server on http://localhost:6006.
- 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.
- Vite
Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects
- UI Kits & Components
A UI kit provides developers with a set of reusable components that can be easily integrated into a website or application. These components are pre-designed with consistent styling and functionality, allowing developers to save time and effort in the design and development process. UI kits can be either custom-built or third-party, and often include components for buttons, forms, typography, icons, and more.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Stylelint
Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.