Quick Start
Get Raypx running locally and learn the fundamentals of the workspace.
What is Raypx?
Raypx is a Turborepo-powered monorepo that hosts a TanStack Start application, shared packages, and tooling aligned around AI-centric product development. It provides a fully type-safe React 19 stack, opinionated UI components, and infrastructure helpers so teams can ship features quickly without rebuilding platform primitives.
Requirements
Before you start, make sure the following tools are installed:
- Node.js 20 or newer (LTS recommended)
- pnpm 10.17 or newer
- Git for version control
Tip: run
node --versionandpnpm --versionto double-check your local versions.
First-Time Setup
git clone https://github.com/raypx/raypx.git
cd raypx
pnpm installcp .env.example .env.local
# Update the new file with environment-specific valuespnpm db:migratepnpm web:dev
# or pnpm dev to run all affected appsThe web app is available at http://localhost:3000. Hot-module reloading and TanStack's file-based routing are enabled out of the box.
Everyday Commands
| Task | Command | Notes |
|---|---|---|
| Format & lint | pnpm format / pnpm check | Biome handles both formatting and linting. |
| Type safety | pnpm typecheck | Runs TypeScript across the entire workspace. |
| Tests | pnpm test | Uses Vitest; try pnpm coverage for HTML coverage reports. |
| Build | pnpm build | Executes the full Turborepo production pipeline. |
| Clean artifacts | pnpm clean | Useful before benchmarking or releasing. |
Recommended Workflow
- Start the local dev server with
pnpm web:dev. - Implement changes in the relevant app or package.
- Run
pnpm checkandpnpm testbefore opening a PR. - Craft conventional commits (e.g.,
feat(web): add onboarding flow) so the CI hooks pass without manual fixes.
Learn More
- Explore the Workspace layout to understand how apps and packages are organized.
- Review the Development workflow for tooling, scripts, and commit guidance.
- Read about Docs & i18n conventions to keep this documentation in sync across languages.