CONTRIBUTING.md

Apps and Packages

• apps/docs: a Next.js documentation site with Tailwind CSS
• apps/web: a Next.js create-llama demo with Tailwind CSS
• packages/chat-ui: a stub React component library with Tailwind CSS shared by both web and docs applications
• packages/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• packages/typescript-config: tsconfig.jsons used throughout the monorepo

Development Guide:

This project uses pnpm as the package manager and Turbo for managing the monorepo. Make sure you have Node.js version 18 or higher installed.

1. Setup:

   • Install dependencies: pnpm install

2. Development:

   • Start the development server: pnpm dev
   • This will run the dev script for all packages in the monorepo

3. Building:

   • Build all packages: pnpm build

4. Linting:

   • Run linter on all packages: pnpm lint

5. Type Checking:

   • Run type checks on all packages: pnpm type-check

6. Cleaning:

   • Clean build artifacts: pnpm clean

7. Formatting:

   • Format all TypeScript, TSX, and Markdown files: pnpm format

Remember to run these commands from the root of the monorepo. Turbo will handle running the commands across all relevant packages.