Summary

This project provides a modern monorepo scaffold for web applications, integrating Astro, tRPC, PostgreSQL, and better-auth. It's specifically tailored for AI-assisted development workflows, offering pre-configured patterns and type-safety to enhance developer productivity with tools like Cursor and GitHub Copilot.

How It Works

The scaffold employs a monorepo architecture managed by Turborepo and PNPM, ensuring efficient builds and package management. It features an Astro frontend, a tRPC backend for type-safe API communication, and Kysely for database interactions with PostgreSQL. Authentication is handled via better-auth with GitHub OAuth, and UI components leverage Tailwind CSS and shadcn/ui. The design prioritizes TypeScript for static typing and includes comprehensive Cursor AI rules to guide AI coding assistants.

Quick Start & Requirements

To begin, clone the repository (note: the provided clone URL is a placeholder). Install dependencies using pnpm install. Set up environment variables in apps/web/.env, including AUTH_SECRET (generate with openssl rand -base64 32), GitHub OAuth credentials (GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET), and a PostgreSQL connection string (DATABASE_URL). Ensure a PostgreSQL server is running, then apply migrations with DATABASE_URL="..." pnpm --filter @app/db db:migrate. Start the development server with pnpm dev; the application will be accessible at http://localhost:3001.

Highlighted Details

• Optimized for AI-assisted development with pre-configured Cursor AI rules covering database patterns, tRPC/React Query integration, component conventions, and TypeScript best practices.
• Full TypeScript coverage ensures robust type safety across the stack, facilitating AI understanding and code generation.
• Leverages Turborepo for high-performance monorepo builds and PNPM for efficient dependency management.
• Includes examples for common patterns like API routing, database migrations, and authentication flows.

Maintenance & Community

The project is authored by @ocavue and @maccman. No community links (e.g., Discord, Slack) or roadmap details are provided in the README.

Licensing & Compatibility

This project is licensed under the MIT License. This permissive license generally allows for commercial use and integration into closed-source projects without significant restrictions.

Limitations & Caveats

As a scaffold, this project serves as a starting point and requires significant configuration for specific project needs, including setting up external services like PostgreSQL and GitHub OAuth. The provided clone URL is a placeholder and needs to be replaced with the actual repository URL.