Skip to main content

Start Here

This path builds the smallest plain Nest/Vite shape that uses Labkit packages. It does not start from Rush.

For production monorepos, Rush is still recommended. See the complete reference implementation, its source repository, the Rush Delivery tutorial, and the official Rush docs.

Target Shape​

labkit-example/
  server/
    src/
  webapp/
    src/

The result is intentionally small:

  • one Nest GraphQL endpoint at /graphql;
  • one query/mutation/subscription path;
  • optional PostgreSQL/TypeORM auth persistence;
  • one React/Vite/Relay client;
  • memory access token plus HttpOnly refresh cookie flow;
  • websocket restart when auth changes;
  • enough structure to extend into a real application.

Create The Workspace​

mkdir labkit-example
cd labkit-example
npm init -y
npm pkg set "workspaces[0]=server" "workspaces[1]=webapp"
mkdir server webapp
npm init -w server -y
npm create vite@latest webapp -- --template react-ts

The npm workspace is only for local convenience. It is not a Rush workspace.

Install Server Packages​

npm install -w server \
  @nestjs/apollo @nestjs/common @nestjs/config @nestjs/core \
  @nestjs/graphql @nestjs/platform-fastify @nestjs/typeorm \
  @apollo/server @fastify/cookie class-transformer class-validator \
  graphql graphql-ws reflect-metadata rxjs typeorm pg

npm install -w server \
  @omgjs/labkit-auth-contract \
  @omgjs/labkit-server-auth \
  @omgjs/labkit-server-auth-typeorm \
  @omgjs/labkit-server-config \
  @omgjs/labkit-server-database \
  @omgjs/labkit-server-graphql \
  @omgjs/labkit-server-observability

Install Browser Packages​

npm install -w webapp \
  graphql graphql-ws react-relay relay-runtime

npm install -w webapp -D \
  @types/react-relay @types/relay-runtime relay-compiler

npm install -w webapp \
  @omgjs/labkit-webapp-auth \
  @omgjs/labkit-webapp-build-config \
  @omgjs/labkit-webapp-external-store \
  @omgjs/labkit-webapp-graphql-relay \
  @omgjs/labkit-webapp-realtime \
  @omgjs/labkit-webapp-ui

Then continue through the pages in order. Each page gives complete file bodies for the Labkit adapter files it introduces.