For the complete documentation index, see llms.txt. Prefer markdown by appending.mdto documentation URLs or sendingAccept: text/markdown.
Development
Run the web app locally with hot reload and shared monorepo packages. The everyday workflow after your environment is ready.
Create your project with the CLI or clone the repository first. Use dependency management for workspace package changes and editor setup for tooling.
Prerequisites
To get started with TurboStarter, ensure you have the following installed and set up:
Project development
Install dependencies
Install the project dependencies by running the following command:
pnpm iWhy pnpm?
It is a fast, disk space efficient package manager that uses hard links and symlinks to save one version of a module only ever once on a disk. It also has a great monorepo support. Of course, you can change it to use Bun, yarn or npm with minimal effort.
Setup environment variables
Create a .env.local files from .env.example files and fill in the required environment variables.
You can use the following command to recursively copy the .env.example files to the .env.local files:
find . -name ".env.example" -exec sh -c 'cp "$1" "${1%.example}.local"' _ {} \;Get-ChildItem -Recurse -Filter ".env.example" | ForEach-Object {
Copy-Item $_.FullName ($\_.FullName -replace '\.example$', '.local')
}Check Environment variables for more details on setting up environment variables.
Setup services
If you want to use local services like database (recommended for development purposes), ensure Docker is running, then setup them with:
pnpm services:setupThis command initiates the containers and runs necessary setup steps, ensuring your services are up to date and ready to use.
Start development server
To start the application development server, run:
pnpm devYour app should now be up and running at http://localhost:3000 🎉
Deploy to Production
When you're ready to deploy the project to production, follow the checklist to ensure everything is set up correctly.
Once the app runs, explore the project structure and coding conventions. When adding routes, use the shared paths configuration. For startup failures, check installation troubleshooting.
Before deploying a release, follow versioning so support and monitoring can identify the build.
How is this guide?
Last updated on
AI-assisted development
Use Cursor, Claude Code, ChatGPT Codex, or Antigravity effectively with TurboStarter. Skills, rules, and workflows that speed up feature work.
Conventions
Naming, folder layout, and coding conventions used across the TurboStarter monorepo. Keep new code consistent with the starter.