Files
whyrating/.context/turbostarter-framework-context/sections/web/installation/development.md
2026-02-04 01:55:00 +01:00

2.7 KiB

title, description, url
title description url
Development Get started with the code and develop your SaaS. /docs/web/installation/development

Development

Prerequisites

To get started with TurboStarter, ensure you have the following installed and set up:

  • Node.js (22.x or higher)
  • Docker (only if you want to use local services e.g. database)
  • pnpm

Project development

### Install dependencies
Install the project dependencies by running the following command:

```bash
pnpm i
```

<Callout title="Why 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](https://pnpm.io/workspaces). Of course, you can change it to use [Bun](https://bunpkg.com), [yarn](https://yarnpkg.com) or [npm](https://www.npmjs.com) with minimal effort.
</Callout>
### 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:

<Tabs items={["Unix (MacOS/Linux)", "Windows"]}>
  <Tab value="Unix (MacOS/Linux)">
    ```bash
    find . -name ".env.example" -exec sh -c 'cp "$1" "${1%.example}.local"' _ {} \;
    ```
  </Tab>

  <Tab value="Windows">
    ```bash
    Get-ChildItem -Recurse -Filter ".env.example" | ForEach-Object {
        Copy-Item $_.FullName ($\_.FullName -replace '\.example$', '.local')
    }
    ```
  </Tab>
</Tabs>

Check [Environment variables](/docs/web/configuration/environment-variables) for more details on setting up environment variables.
### Setup services
If you want to use local services like [database](/docs/web/database/overview) (**recommended for development purposes**), ensure Docker is running, then setup them with:

```bash
pnpm services:setup
```

This 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:

```bash
pnpm dev
```

Your app should now be up and running at [http://localhost:3000](http://localhost:3000) 🎉
### Deploy to Production
When you're ready to deploy the project to production, follow the [checklist](/docs/web/deployment/checklist) to ensure everything is set up correctly.