Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 3.36 KB

README.md

File metadata and controls

106 lines (74 loc) · 3.36 KB

Roboto Studio Turborepo/Sanity/Next starter

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

Getting started

  1. Clone repo 
    git clone https://github.com/robotostudio/website-turborepo
  2. Install dependencies 
    yarn
  3. Setup Sanity 
    cd app/studio && sanity init
    This will prompt you if you want to reconfigure the project. Answer yes and follow instructions to create a new project.
  4. Setup Vercel deployment 
    vercel
    When asked about build settings, make sure to use yarn dev as the development command

Notes

In development (using yarn dev)

What's inside?

This turborepo uses Yarn as a package manager. It includes the following packages/apps:

Apps and Packages

  • web: a Next.js app
  • sanity: a Sanity CMS
  • config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • tsconfig: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

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

Setup

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).

Build

To build all apps and packages, run the following command:

cd my-turborepo
yarn run build

Develop

To develop all apps and packages, run the following command:

cd my-turborepo
yarn run dev

Remote Caching

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

Useful Links

Learn more about the power of Turborepo: