Skip to content

devsoc-unsw/ui-components

Repository files navigation

CSESoc UI Components

This repository houses the components used for CSESoc's upcoming design system.

Installation Documentation Contributing

Installation

This is currently under development and cannot be installed.

Contributing

To get started:

  1. Clone the repository
    git clone https://github.com/csesoc/ui-components
  1. Run pnpm install in the root of the repository.

  2. To view the storybook, run pnpm run storybook in /apps/storybook.

  3. To develop locally, run pnpm run dev in /packages/components.

  4. Ensure that your code is properly linted and formatted.

  5. Commit your changes and open a pull request.