Coinbase Design System

Welcome to the Coinbase Design System (CDS)!

Please visit our website https://cds.coinbase.com for the latest documentation.

Setup

1. Clone the repository

git clone git@github.com:coinbase/cds.git
cd cds

2. Use the correct Node.js version

We suggest nvm to manage Node.js versions. If you have it installed, you can use these commands to set our current Node.js version.

nvm install
nvm use
corepack enable

3. Install dependencies

yarn install

Quick Start

Run one of the available apps to get started:

Storybook (Web)

yarn nx run storybook:dev

Documentation Site

yarn nx run docs:dev

Mobile App

# Launch local debug builds
yarn nx run mobile-app:launch:ios-debug
yarn nx run mobile-app:launch:android-debug

Contributing

We welcome contributions to the Coinbase Design System! Please read our Contributing Guide for details on our development process, coding standards, and how to submit pull requests.

Versioning

CDS generally follows Semantic Versioning.

We aim to preserve type/public API compatibility across minor and patch releases. Visual changes are allowed in minor releases. Review changelog entries and validate UI when upgrading.

Security

For information about reporting security vulnerabilities, please see our Security Policy.

License

This project is licensed under the terms described in LICENSE.