Get started

​

Welcome to TurboStack

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

​

Make it yours

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

npm install -g pnpm@latest

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

mv .env.example .env.local

3. In your terminal, run the following command:

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

​

Project Structure

This boilerplate uses Turborepo to manage a Monorepo structure that have two main folders:

/apps → This is where you will put your applications that will be online later.
/packages → This is where you will put all the shared packages between your applications.

​

Available Applications

/apps/docs → A base documentation application, like this one, based on Mintlify.
/apps/web → Your base Nextjs application.

​

Available Packages

/packages/emails → A list of react.email templates to use it in your applications.
/packages/eslint-config → A base ESLint config file to share between your applications.
/packages/tailwind-config → A base TailwindCSS config file to share between your applications.
/packages/typescript-config → A base tsconfig.json file to share between your applications.
/packages/ui → A list of shadcn components to use in your applications.
/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: