Files
trpc-nuxt/docs/content/1.get-started/1.installation.md
Robert Soriano 45fbab4c5f update docs
2022-10-30 21:40:20 -07:00

1.7 KiB

title, description
title description
Installation tRPC-Nuxt provides first class integration with tRPC.

Installation

1. Add to existing Nuxt project

::code-group

pnpm add @trpc/server@next @trpc/client@next trpc-nuxt@beta zod
npm install @trpc/server@next @trpc/client@next trpc-nuxt@beta zod
yarn add @trpc/server@next @trpc/client@next trpc-nuxt@beta zod

::

Why @trpc/server?

For implementing tRPC endpoints and routers.

Why @trpc/client?

For making typesafe API calls from your client.

Why zod?

Most examples use Zod for input validation and tRPC.io highly recommends it, though it isn't required.

2. Install module

This will transpile trpc-nuxt and exclude trpc-nuxt/client from optimized dependencies by Vite.

export default defineNuxtConfig({
  modules: ['trpc-nuxt/module']
})

3. Enable strict mode

If you want to use Zod for input validation, make sure you have enabled strict mode:

::code-group

{
  "extends": "./.nuxt/tsconfig.json",
  "compilerOptions": {
    "strict": true
  }
}
export default defineNuxtConfig({
  typescript: {
    strict: true
  }
})

::

If strict mode is too much, at least enable strictNullChecks:

::code-group

{
  "extends": "./.nuxt/tsconfig.json",
  "compilerOptions": {
    "strictNullChecks": true
  }
}
export default defineNuxtConfig({
  typescript: {
    tsConfig: {
      strictNullChecks: true
    }
  }
})

::

Next Steps

Now that you've installed the required dependencies, you are ready to start building your application.