Following the announcement of Vercel accquiring TurboRepo, we wanted to pull together all our favourite packages to create a "best in class" framework for building a website
- Clone repo
git clone https://github.com/robotostudio/website-turborepo
- Install dependencies
yarn
- Setup Sanity
This will prompt you if you want to reconfigure the project. Answer yes and follow instructions to create a new project.
cd app/studio && sanity init
- Setup Vercel deployment
When asked about build settings, make sure to use
vercel
yarn dev
as the development command
In development (using yarn dev
)
- The Next.js application will run on https://localhost:3000
- The Sanity Studio dev server will run on http://localhost:3333/studio
This turborepo uses Yarn as a package manager. It includes the following packages/apps:
web
: a Next.js appsanity
: a Sanity CMSconfig
:eslint
configurations (includeseslint-config-next
andeslint-config-prettier
)tsconfig
:tsconfig.json
s used throughout the monorepo
Each package/app is 100% TypeScript.
This turborepo has some additional tools already setup for you:
- TypeScript for static type checking
- ESLint for code linting
- Jest test runner for all things JavaScript
- Prettier for code formatting
- Chakra UI an awesome frontend framework similar to tailwind
This repository is used in the npx create-turbo
command, and selected when choosing which package manager you wish to use with your monorepo (Yarn).
To build all apps and packages, run the following command:
cd my-turborepo
yarn run build
To develop all apps and packages, run the following command:
cd my-turborepo
yarn run dev
Turborepo can use a technique known as Remote Caching (Beta) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
By default, Turborepo will cache locally. To enable Remote Caching (Beta) you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:
cd my-turborepo
npx turbo login
This will authenticate the Turborepo CLI with your Vercel account.
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
npx turbo link
Learn more about the power of Turborepo: