@patreon/studio

Studio Design System

Introduction

Studio Design System is Patreon’s web design system and is built with React and Styled Components and written in Typescript.

The docs for Studio Design System live at https://studio.patreon.com

Getting Started

Installation

npm i -P @patreon/studio

How to use

View available Studio components and how to use them in the docs.

As an example, here’s how you’d import the Text component:

import { Text } from '@patreon/studio'

Docs

We use Docz to generate the Studio docs that live at https://studio.patreon.com.

How to run the docs locally

Run npm run docs:server and open localhost:3003 in your browser.

Storybook

Storybook is a component development environment. Our version of Storybook uses the component story format, which expects stories to be written in the following format.

export ExampleStory = () => <ExampleComponent />

How to run Storybook locally

Run npm run storybook.

Tests

How to run tests

Run npm run test or npm run test:watch

How to use Happo locally

Happo is our tool for visual regression testing. It's integrated as part of our CircleCI tests, but can also be run locally, with a little bit of setup:

1. Open up 1Password and search for a secure note titled: "Happo .env Variables - Studio"
2. Create a .env file in the studio directory (it will be ignored by git)
3. Add the .env variables from the 1Password document to the new file.
4. If you haven’t already, run npm install to make sure dependencies are installed (dotenv in particular).
5. Run npm run happo dev, which will watch files for changes and with the --only flag can be limited to specific components. See the docs for more info.
6. Happo will run tests, then provide a url where you can see the report.

Developing in PRF

If you haven't done it, checkout studio into a sibling directory of PRF and then run devx sync.

From within a devx attach session, go to /opt/code/studio and run npm install and then run npm run prf:link to link your local dev version of studio to PRF. This script will also watch for changes and rebuild as needed. Each rebuild isn't particularly fast, so it's recommended you watch the console output to know when it's safe to reload your dev browser. See npm run prf:link -- --help for more info.

rdev instructions

You can develop in Studio and PRF similarly in rdev. If you don't already have a PRF container in rdev, create one:

• rdev new patreon_react_features --name prf Open an SSH session to your container:
• rdev ssh prf

Inside your container, install Studio in the home directory

• cd /home/dev
• git clone [e-mail]:Patreon/studio.git

Run the same instructions as above:

• cd studio
• npm install
• npm run prf:link

Clean up when done

Run npm run prf:unlink to revert to the published version of Studio.