Skip to content

README.md

Latest commit

 

History

History
56 lines (36 loc) · 1.03 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.03 KB
Raw

Polar Clients

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

  • apps/web: polar.sh – Next.js app
  • packages/ui: Shared resources
  • packages/sdk: API types

Each package/app is 100% TypeScript.

Install

pnpm install

Build

To build all apps and packages, run the following command:

pnpm build

Develop web

pnpm dev-web

Generate API definitions

pnpm generate

Adding a new API class? You might need to manually add the generated model to src/client/PolarAPI.ts in the SDK package.

Designing with Storybook

Polar uses Storybook to make it easier to work with web components and their design.

To run the Storybook locally:

# from the "clients" directory
pnpm install
pnpm storybook

The storybook should start and run on http://localhost:6006/.