Skip to content

Latest commit

 

History

History
105 lines (66 loc) · 5.54 KB

README.md

File metadata and controls

105 lines (66 loc) · 5.54 KB
Raw

tRPC Server Client Turborepo Template

🚧 This is a TEMPLATE 🚧

A clean template designed to kickstart your project, sparing you the effort of configuring everything from scratch.

This is a straightforward monorepo that includes an Express tRPC server with Prisma ORM. The server interacts with a Next.js application and provides a wide range of features through tRPC.

With this template, you can quickly set up a powerful server-client architecture for your web application. The combination of Express, tRPC, Prisma and Next.js offers a seamless development experience and enables you to build robust and efficient applications with the ease of adding API documentation through OpenApi and SwaggerUI which comes integrated into this template.

Feel free to use this template as a starting point for your projects and customize it according to your specific requirements.

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

  • apps/docs: A simple Next.js app that can be used to compare changes made to the apps/web application. It serves as a reference to understand the modifications.
  • apps/server: This is a TypeScript Express tRPC server with swaggerUI. It provides the backend functionality for your application and handles API requests. packages/trpc is connected to the server and contains all the procedures.
  • apps/web: another Next.js app with tRPC Client which interacts with api package. It also incorporates TailwindCSS for styling.
  • packages/trpc: everything related to tRPC including procedures and trpc-openapi exists in this package folder which is currently being used by server.
  • packages/ui: a stub React component library shared by both web and docs applications. It includes reusable components and is styled using TailwindCSS.
  • packages/prisma: A powerful database ORM that offers type safety and is utilized by the trpc package to enhance the developer experience.
  • packages/eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • packages/tsconfig: tsconfig.jsons used throughout the monorepo
  • packages/tailwind-config: tailwind configuration which is used throughout the monorepo
  • packages/prettier-config: This package includes the styling configuration for Prettier, ensuring consistent code formatting throughout the monorepo

Project Setup

In the root directory, install dependencies by running.

cd trpc-server-client-turborepo-template
yarn

Setting up .env file - Copy .env.example file and rename it to .env in the root directory

Setting up Database

To configure the database for your project, you have two options:

  1. If you have postgresql database ready, add the connection string to DATABASE_URL.

  2. If you don't have a database and have Docker installed on your system, you can easily set it up using the following script command in your CLI:

yarn prisma db-up

Note : To check the environment details you can find the docker-compose file in packages/prisma/docker-compose.yaml

Scripts

Scripts can be ran in the root directory by typing the following in cli.

  • yarn run dev : Runs the entire monorepo.
  • yarn prisma studio : Runs prisma studio from package/prisma
  • yarn prisma migrate : Runs prisma database migrations from package/prisma
  • yarn prisma db-up : Installs/Runs postgresql image from package/prisma in Docker.

Build

To build all apps and packages, run the following command:

cd trpc-server-client-turborepo-template
yarn

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd trpc-server-client-turborepo-template
npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

npx turbo link

Contributions

I welcome contributions to help improve this template! If you have any issues or recommendations for enhancements, please feel free to raise them. Your feedback is valuable and will help me make this template even better.

To contribute, you can:

  • Raise an issue: If you encounter any problems or have suggestions for improvements, please create an issue on this GitHub repository. I will review it and work together with you to find a solution.

  • Submit a pull request: If you have a specific improvement in mind, you can fork the repository, make your changes, and submit a pull request. I will review your changes and merge them if they align with the project's goals.

By contributing to this template, you'll be helping not only me but also the community by making it more robust and user-friendly! At the moment I would really appreciate some help with file structure recommendations for Turborepo for the technologies inside the repository.

Thank you for your support!