Danny White
73f8a15203
* user newer input in api keys * user newer input in s3 connection settings * improve input read-only styles * make API text selectable * disable text until reveal button tapped * fix build * revert change * fix other cases * revert hardcoded example * nice region field * documentation * cleanup * better docs * colour tweaks
Supabase Design System
Design resources for building consistent user experiences at Supabase.
Getting started
First, make a copy of .env.local.example and name it env.local. Then install any required packages and start the development server:
cd apps/design-system
pnpm i
pnpm dev:full
The dev:full command runs both the Next.js development server and Contentlayer concurrently, which is recommended for most development workflows.
Alternative commands
You can also run the development server and content watcher separately:
# Run only the Next.js development server
pnpm dev
# Run only the content watcher (in a separate terminal shell)
pnpm content:dev
Or run the development server from the root directory:
pnpm dev:design-system
To run both the development server and content watcher from the root directory, you can use:
# Run the development server
pnpm dev:design-system
# Run the content watcher (in a separate terminal shell)
pnpm --filter=design-system content:dev
Open http://localhost:3003 in your browser to see the result.
Watching for MDX changes
The dev:full command automatically watches for changes to MDX files with hot reload. If you're running the pnpm dev separately, you'll need to run pnpm content:dev in a separate terminal shell to watch for content changes.
Adding components
The design system references components rather than housing them. That’s an important distinction to make, as everything that follows here is about the documentation of components. You can add or edit components in one of these two places:
packages/ui: basic UI componentspackages/ui-patterns: components which are built using NPM libraries or amalgamations of components frompatterns/ui
With that out of the way, there are several parts of this design system that need to be manually updated after components have been added or removed (from documentation). These include:
config/docs.ts: list of components in the sidebarcontent/docs: where the actual component documentation.mdxfile livesregistry/examples.ts: list of example componentsregistry/default/example: where the actual example component(s) liveregistry/charts.ts: Chart componentsregistry/fragments.ts: Fragment components
You will need to rebuild the design system’s registry each time a new example component is added. In other words: whenever a new file enters registry, it needs to be rebuilt. You can do that via:
cd apps/design-system
pnpm build:registry