> ## Documentation Index
> Fetch the complete documentation index at: https://docs.turbostack.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get started

## Welcome to TurboStack

Here's a quick setup of the template. Do the following steps to get your app up and running.

<Warning>TurboStack uses the latest LTS Version of Node: v20.17.0. Check your version running `node -v` in your terminal</Warning>

## Make it yours

1. First of all, this template use `pnpm` as a package manager. Install it using the following command:

```bash theme={null}
npm install -g pnpm@latest
```

2. Rename `.env.example` to `.env.local` from `apps/web`

```bash theme={null}
mv .env.example .env.local
```

3. In your terminal, run the following command:

```bash theme={null}
git clone git@github.com:turbostackinc/turbostack.git {{YOUR_APP}} &&
cd {{YOUR_APP}} &&
pnpm install && 
git remote remove origin &&
pnpm run build &&
pnpm run dev
```

4. Open `http://localhost:3000` to see your site. It'll open a page like this

<img src="https://mintcdn.com/ravitechsolutions/jCk1IPeJr8ul3nyO/images/main-page.png?fit=max&auto=format&n=jCk1IPeJr8ul3nyO&q=85&s=43f3faa617fa996b766f9863ec486a30" alt="Main Page of TurboStack" width="970" height="547" data-path="images/main-page.png" />

## Project Structure

This boilerplate uses [Turborepo](https://turbo.build/repo) to manage a Monorepo structure that have two main folders:

<Icon icon="folder" iconType="solid" /> **/apps** → This is where you will put your applications that will be online later. \
<Icon icon="folder" iconType="solid" /> **/packages** → This is where you will put all the shared packages between your applications.

### Available Applications

<Icon icon="folder" iconType="solid" /> **/apps/docs** → A base documentation application, like this one, based on [Mintlify](https://mintlify.com?ref=turbostack.io). \
<Icon icon="folder" iconType="solid" /> **/apps/web** → Your base Nextjs application.

### Available Packages

<Icon icon="folder" iconType="solid" /> **/packages/emails** → A list of [react.email](https://react.email) templates to use it in your applications. \
<Icon icon="folder" iconType="solid" /> **/packages/eslint-config** → A base ESLint config file to share between your applications. \
<Icon icon="folder" iconType="solid" /> **/packages/tailwind-config** → A base TailwindCSS config file to share between your applications. \
<Icon icon="folder" iconType="solid" /> **/packages/typescript-config** → A base `tsconfig.json` file to share between your applications. \
<Icon icon="folder" iconType="solid" /> **/packages/ui** → A list of [shadcn](https://ui.shadcn.com) components to use in your applications. \
<Icon icon="folder" iconType="solid" /> **/packages/utils** → Shared `constants` and `functions` to use in your applications.

***

With all things done, you can now go ahead and do one of the following tutorials:

<CardGroup cols={2}>
  <Card title="Ship in five minutes" icon="rocket" href="ship-in-five">
    Set up your landing page and make it online.
  </Card>

  <Card title="Setup your environment" icon="gear" href="tutorials/setup-dev-environment">
    Configure your `app` subdomain for development.
  </Card>
</CardGroup>
