Skip to content

Guarding the brand integrity of the Digital University realm by creating a flexible and extensible design system.

License

Notifications You must be signed in to change notification settings

omnifed/cerberus

Repository files navigation

Cerberus Design System

banner

NPM Version JSR NPM License

Architecture

Cerberus archictecture visual

Guarding the brand integrity of the Digital University realm by creating a flexible and extensible design system.

Repository structure

This is a monorepo that uses pnPm to manage dependencies and Bun as the runtime language. You will need to install these tools to work on this project.

JSR Requirements

We follow the slow requirements process of the JSR publishing standard. This means you will be required to define the return types of all your exports which result in the following:

  1. Significantly improve your package users' type checking performance.
  2. Improve the automatic documentation generation.
  3. Enable automatic .d.ts generation for Node.js.

Getting started

Install Required Tools

  1. Install pnpm
  2. Install Bun

Setup the project

After you fork the repository, install the dependencies by running the following command in the root of the project:

pnpm install

This will install all the dependencies for the project including the workspaces.