Skip to content
This repository has been archived by the owner on Oct 13, 2024. It is now read-only.

Latest commit

 

History

History
62 lines (38 loc) · 1.6 KB

README.md

File metadata and controls

62 lines (38 loc) · 1.6 KB
Raw

Nitro tRPC Starter

Welcome to the Nitro tRPC Starter repository! This project provides a boilerplate to help you kickstart a full-stack application using tRPC with Nitro.

Features

  • Type Safety: Full-stack type safety enabled by tRPC.
  • API Routes: Effortless creation of serverless functions using Nitro.
  • Scalable: Suitable for building scalable and performant applications.
  • Developer Experience: Pre-configured with best practices and tools for a great developer experience.

Getting Started

Prerequisites

Before you start, make sure you have the following installed:

  • Node.js (>= 18.x)
  • pnpm (>=9)

Installation

Clone the repository and install the dependencies:

git clone https://github.com/fisand/nitro-trpc-starter.git
cd nitro-trpc-starter
pnpm install

Running the Development Server

To start the development server, run:

pnpm run dev

This command will start a local development server with hot-reloading.

Building for Production

To build the application for production, use:

pnpm run build

This will create an optimized version of your application in the dist/ directory.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgements

  • tRPC for type-safe APIs.
  • Nitro for powerful server-side capabilities.