Skip to content

Latest commit

 

History

History
135 lines (99 loc) · 5.46 KB

README.md

File metadata and controls

135 lines (99 loc) · 5.46 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Create tRPC App

The easiest way to get started with tRPC!
Explore the docs »

Report Bug · Request Feature

Buy Me A Coffee

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Options
  5. Why use Create tRPC App?
  6. Acknowledgments

About The Project

The easiest way to get started with tRPC is by using create-trpc-appx. This CLI tool enables you to quickly start building a new tRPC application, with everything set up for you. You can create a new app using the default tRPC template, or by using one of the official tRPC examples.

Getting Started

Prerequisites

Some examples use yarn, so you may need to install it after creating a new project.

Usage

To get started, use the following command:

npx create-trpc-appx@latest <FOLDER NAME>
# or
yarn create trpc-appx <FOLDER NAME>
# or
pnpm create trpc-appx <FOLDER NAME>

(back to top)

Options

create-trpc-appx comes with the following options:

  • -e, --example [name]|[github-url] - An example to bootstrap the app with. You can use an example name from the tRPC repo or a GitHub URL. The URL can use any branch and/or subdirectory.
  • --example-path <path-to-example> - In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: --example-path foo/bar
  • --use-npm - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we recommend to run yarn create trpc-appx <FOLDER NAME>
  • --use-pnpm - Explicitly tell the CLI to bootstrap the app using pnpm. To bootstrap using pnpm we recommend running pnpm create trpc-appx <FOLDER NAME>

(back to top)

Why use Create tRPC App?

create-trpc-appx allows you to create a new tRPC app within seconds. It includes a number of benefits:

  • Interactive Experience: Running npx create-trpc-appx (with no arguments) launches an interactive experience that guides you through setting up a project.
  • Offline Support: Create tRPC App will automatically detect if you're offline and bootstrap your project using your local package cache.
  • Support for Examples: Create tRPC App can bootstrap your application using an example from the tRPC examples collection (e.g. npx create-trpc-appx --example fastify-server).

Acknowledgments

This project has been based on Create Next App, so a huge thank you goes to every and single one who worked on it.

Attribution for one of the icons used in the logo: Design icons created by monkik - Flaticon

(back to top)