Skip to Content

Installation

CrudKit is designed to work with Drizzle ORM, tRPC, and React Query. This guide will help you install all the required packages.

Requirements

CrudKit requires the following peer dependencies:

  • React >=17.0.0
  • Drizzle ORM >=0.28.0
  • tRPC >=10.0.0
  • React Query (via tRPC)
  • Zod >=3.0.0

Installing CrudKit

You can install CrudKit using your preferred package manager:

# npm
npm install crudkit
 
# yarn
yarn add crudkit
 
# pnpm
pnpm add crudkit

Installing Dependencies

If you haven’t already installed the required peer dependencies, you can do so using your package manager:

# npm
npm install drizzle-orm @trpc/server @trpc/client @trpc/react-query zod
 
# yarn
yarn add drizzle-orm @trpc/server @trpc/client @trpc/react-query zod
 
# pnpm
pnpm add drizzle-orm @trpc/server @trpc/client @trpc/react-query zod

Next Steps

After installing CrudKit and its dependencies, you can proceed to the Quick Start guide to learn how to set up your first CRUD operations.

Last updated on