https://github.com/ipenywis/your-react-boilerplate
The Pro React Project Boilerplate you need https://youtu.be/nm8UWffANOc
https://github.com/ipenywis/your-react-boilerplate
Last synced: 5 months ago
JSON representation
The Pro React Project Boilerplate you need https://youtu.be/nm8UWffANOc
- Host: GitHub
- URL: https://github.com/ipenywis/your-react-boilerplate
- Owner: ipenywis
- Created: 2023-01-10T14:14:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-05T06:08:48.000Z (almost 2 years ago)
- Last Synced: 2024-08-03T22:24:12.520Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 410 KB
- Stars: 109
- Watchers: 2
- Forks: 26
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - ipenywis/your-react-boilerplate - The Pro React Project Boilerplate you need https://youtu.be/nm8UWffANOc (JavaScript)
README
# React Pro Boilerplate
This Project setup and the motivation behind it is explained in the CoderOne youtube channel.
Setup Video: https://youtu.be/nm8UWffANOc
---
## Turborepo starter
This is an official Yarn v1 starter turborepo.
## What's inside?
This turborepo uses [Yarn](https://classic.yarnpkg.com/) as a package manager. It includes the following packages/apps:
### Apps and Packages
- `docs`: a [Next.js](https://nextjs.org/) app
- `web`: another [Next.js](https://nextjs.org/) app
- `ui`: a stub React component library shared by both `web` and `docs` 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/).
### 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 my-turborepo
yarn run build
```
### Develop
To develop all apps and packages, run the following command:
```
cd my-turborepo
yarn 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 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
```
## Useful Links
Learn more about the power of Turborepo:
- [Pipelines](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)