https://github.com/htcni/turborepo-next-express-shadcnui-starter
Turborepo boilerplate project designed to kickstart web development using a powerful stack consisting of Next.js, Express, and ShadcnUI.
https://github.com/htcni/turborepo-next-express-shadcnui-starter
shadcn-ui turborepo turborepo-starter
Last synced: 2 months ago
JSON representation
Turborepo boilerplate project designed to kickstart web development using a powerful stack consisting of Next.js, Express, and ShadcnUI.
- Host: GitHub
- URL: https://github.com/htcni/turborepo-next-express-shadcnui-starter
- Owner: htcni
- Created: 2023-08-03T18:20:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-10T05:55:19.000Z (about 2 years ago)
- Last Synced: 2023-08-10T06:54:31.870Z (about 2 years ago)
- Topics: shadcn-ui, turborepo, turborepo-starter
- Language: TypeScript
- Homepage:
- Size: 115 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-shadcnui - Github
README
# Turborepo Next Express ShadcnUI starter
This is a starter template for Turborepo with nextjs, express and shadcnui.
## Using this example
Run the following command:
```sh
git clone https://github.com/htcni/turborepo-next-express-shadcnui-starter.git
```
## What's inside?
This Turborepo includes the following packages/apps:
### Apps and Packages
- `admin`: a [Next.js](https://nextjs.org/) app
- `web`: another [Next.js](https://nextjs.org/) app
- `api`: a [Express.js](https://expressjs.com/) app
- `ui`: a [shadcn/ui](https://ui.shadcn.com/) components shared by both `web` and `admin` applications
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `tsconfig`: `tsconfig.json`s used throughout the monorepo
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
## Adding shadcn component
Run the following command:
```sh
npm run ui:add accordion --workspace=ui
```
### 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
### Build
To build all apps and packages, run the following command:
```
cd turborepo-next-express-shadcnui-starter
npm run build
```
### Develop
To develop all apps and packages, run the following command:
```
cd turborepo-next-express-shadcnui-starter
npm run dev
```
### Remote Caching
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), then enter the following commands:
```
cd turborepo-next-express-shadcnui-starter
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
```
## 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)