Skip to content

Commit 65c191d

Browse files
committed
docs: Add Getting Started section to root README
1 parent 97e69f8 commit 65c191d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,9 @@ A starter kit for building a monorepo with Turborepo and pnpm.
1010
- `config/*`: Packages containing shared configurations for ESLint, TypeScript, and Vitest.
1111
- `packages/*`: Shared packages used across applications.
1212
- `/ui/`: A shared UI component library using React and Tailwind CSS.
13+
14+
## Getting Started
15+
16+
1. (optional) Rename the package namespace from `@starter` to your desired namespace in all `package.json` files.
17+
2. Install dependencies by running `pnpm install` in the root directory.
18+
3. Start developing by running `pnpm dev` to launch the Next.js app, Storybook, and UI package.

0 commit comments

Comments
 (0)