lachlanhawthorne / keystone-next-monorepo

KeystoneJS and Next.js monorepo with SSR

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

KeystoneJS & Next.js Monorepo

Example monorepo using KeystoneJS, Next.js, GraphQL Code Generator and urql

Apps, Packages & Wrappers

  • web: a Next.js app
  • ui: a stub React component library shared by both web and docs applications
  • operations: a place to store GraphQL operations to generate queries for client applicaitons
  • data-access: Data access wrapper using urql to generate SSR props for Next.js
  • 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:

Setup

To begin, you will need to provide your KeystoneJS GraphQL API url as an environment variable in the .env file at the top level of the monorepo.

Once you have added this in you will need to initialize Keystone and add in some posts.

After you have added in posts, they will show up server-side rendered in the web app

Build

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

cd keystone-next-monorepo
yarn run build

Develop

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

cd keystone-next-monorepo
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 keystone-next-monorepo
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:

About

KeystoneJS and Next.js monorepo with SSR


Languages

Language:TypeScript 98.5%Language:JavaScript 1.4%Language:Shell 0.1%