44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
# {{project-name}}
|
|
|
|
A full-stack monorepo managed by [Vibn](https://vibnai.com), powered by [Turborepo](https://turbo.build).
|
|
|
|
## Apps
|
|
|
|
| App | Path | Purpose |
|
|
|-----|------|---------|
|
|
| `product` | `apps/product` | Core user-facing application |
|
|
| `website` | `apps/website` | Marketing and landing pages |
|
|
| `admin` | `apps/admin` | Internal admin tooling |
|
|
| `storybook` | `apps/storybook` | Component browser and design system |
|
|
|
|
## Shared Packages
|
|
|
|
| Package | Path | Purpose |
|
|
|---------|------|---------|
|
|
| `@{{project-slug}}/ui` | `packages/ui` | Shared React components |
|
|
| `@{{project-slug}}/tokens` | `packages/tokens` | Design tokens (colors, spacing, typography) |
|
|
| `@{{project-slug}}/types` | `packages/types` | Shared TypeScript types |
|
|
| `@{{project-slug}}/config` | `packages/config` | Shared eslint and tsconfig |
|
|
|
|
## Getting Started
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm dev
|
|
```
|
|
|
|
## Running a specific app
|
|
|
|
```bash
|
|
turbo run dev --filter=product
|
|
turbo run dev --filter=website
|
|
```
|
|
|
|
## Building
|
|
|
|
```bash
|
|
pnpm build
|
|
# or a single app
|
|
turbo run build --filter=product
|
|
```
|