An open API service indexing awesome lists of open source software.

https://github.com/mausic/turborepo-next-nest-boilerplate

The turborepo boilerplate with Next.js, Nest.js, Clerk, Redis and other
https://github.com/mausic/turborepo-next-nest-boilerplate

nestjs nestjs-backend nextjs prisma prisma-orm redis-cache shadcn-ui starter-kit tailwindcss template turborepo-starter

Last synced: 7 months ago
JSON representation

The turborepo boilerplate with Next.js, Nest.js, Clerk, Redis and other

Awesome Lists containing this project

README

          

# Tubrorepo Boilerplate with Next.js, Nest.js, Clerk, Redis, etc

THIS IS A WORK IN PROGRESS!
Use it at your own risk

## Using this boilerplate

The philosophy of this repo is "Fork you!":

1. Fork the repo
2. Do whatever you want
3. ...
4. PROFIT!!!

## What's inside?

This Turborepo includes the following packages/apps:

### Apps and Packages

- `web`: a [Next.js](https://nextjs.org/) app with a Tailwind v4 and basic shadcn/ui dashboard layout and [Clerk](https://clerk.com/) authentication [WIP]
- `api` a [Nest.js](https://nestjs.com) app with a basic setup (clerk auth, redis caching, swagger docs) [WIP]
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications [WIP]
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
- `@repo/db`: a [Prisma ORM](https://prisma.io/orm) database as a package that may be used in apps
- `@repo/redis` a [Redis](https://redis.io) in-memory storage docker setup

Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).

### Utilities

This Turborepo has some additional tools already setup for you:

- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
- [Commitlint](https://commitlint.js.org/) for checking the commit messages
- [Lint-staged](https://github.com/lint-staged/lint-staged) for checking the code you are commiting

### Turbo

This repo is fully configured with turbo. It means that running `turbo dev` will preconfigure all necessary development services (docker containers including) and afterwards will start all the apps.

### 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

> [!TIP]
> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).

Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/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](https://vercel.com/signup?utm_source=turborepo-examples), then enter the following commands:

```
cd my-turborepo
npx turbo login
```

This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).

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

```
npx turbo link
```

## Contribution

I don't really believe that somebody will ever find this repo and will decide to contribute, but you do -> please make a PR

## Useful Links

Learn more about the power of Turborepo:

- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)

## Roadmap

### API

- [ ] implement throttling
- [ ] imlpement microservices via NATS

### WEB

- [ ] implement onboarding flow
- [ ] implement organizations module from Clerk

### UI

- [ ] implement shadcn/ui package

### DOCS

- [ ] implement docs web app (via mintlify probably?)

### Realeases

- [ ] imlpement web app with releases or a notifications module?