NestJS Turborepo starter

A monorepo boilerplate built with Turborepo and NestJS.

Realworld Demo: https://nestjs-realworld-api.onrender.com/api-docs

Getting started

# Clone the repository
git clone https://github.com/vndevteam/nestjs-turbo.git

# Create environment variables file.
cp apps/realworld-api/.env.example apps/realworld-api/.env
cp apps/user-api/.env.example apps/user-api/.env

# Install dependences.
pnpm install

Checklist

When you use this template, try follow the checklist to update your info properly

• Change the author name in LICENSE
• Change configurations in .env
• Remove the .github folder which contains the funding info
• Clean up the README.md file

What's inside?

This project includes the following packages/apps:

Apps and Packages

• docs: a Next.js app
• web: another Next.js app
• @repo/ui: a stub React component library shared by both web and docs applications
• @repo/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• @repo/typescript-config: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This project has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Build

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

cd my-turborepo
pnpm build

Develop

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

cd my-turborepo
pnpm dev

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 my-turborepo
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

Useful Links

Learn more about the power of Turborepo:

• Tasks
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage

Support

Discuss on Github