CONTRIBUTING.md

Contribute to aragonUI

Build

Clone this repository and install the dependencies:

npm install

Build:

npm run build

Auto rebuild:

npm run dev

Develop

The devbox/ directory contains an app that can be used to develop components.

To develop using it, you have to link aragonUI first:

# Assuming you are in the root aragon-ui directory (i.e. cd aragon-ui/)

# Link @aragon/ui locally and into the devbox package
yarn link
cd devbox/
yarn link @aragon/ui
cd ../

# Rebuild on change
yarn dev

And launch the devbox development server:

# shell session 2
yarn devbox

Structure

src/
  components/   # The React components.
  hooks/        # React hooks.
  icons/        # Contains the icon components exported by aragonUI.
    components/ # Icon components (autogenerated)
    svg/        # Icon SVG files used to generate the icon components.
  libs/         # Internal library, contains various utilities. Nothing here is exported.
  providers/    # React providers.
  style/        # Everything related to the styles: spring configs, text styles, etc.
  theme/        # The theming system.
  utils/        # Public utility library. Everything in there is exported and part of the public API.
  vendor/       # This is where external libraries can get exported as-is.