···11+# Turborepo starter
22+33+This is an official starter Turborepo.
44+55+## Using this example
66+77+Run the following command:
88+99+```sh
1010+npx create-turbo@latest
1111+```
1212+1313+## What's inside?
1414+1515+This Turborepo includes the following packages/apps:
1616+1717+### Apps and Packages
1818+1919+- `docs`: a [Next.js](https://nextjs.org/) app
2020+- `web`: another [Next.js](https://nextjs.org/) app
2121+- `ui`: a stub React component library shared by both `web` and `docs` applications
2222+- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
2323+- `tsconfig`: `tsconfig.json`s used throughout the monorepo
2424+2525+Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
2626+2727+### Utilities
2828+2929+This Turborepo has some additional tools already setup for you:
3030+3131+- [TypeScript](https://www.typescriptlang.org/) for static type checking
3232+- [ESLint](https://eslint.org/) for code linting
3333+- [Prettier](https://prettier.io) for code formatting
3434+3535+### Build
3636+3737+To build all apps and packages, run the following command:
3838+3939+```
4040+cd my-turborepo
4141+pnpm build
4242+```
4343+4444+### Develop
4545+4646+To develop all apps and packages, run the following command:
4747+4848+```
4949+cd my-turborepo
5050+pnpm dev
5151+```
5252+5353+### Remote Caching
5454+5555+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.
5656+5757+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:
5858+5959+```
6060+cd my-turborepo
6161+npx turbo login
6262+```
6363+6464+This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
6565+6666+Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
6767+6868+```
6969+npx turbo link
7070+```
7171+7272+## Useful Links
7373+7474+Learn more about the power of Turborepo:
7575+7676+- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
7777+- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
7878+- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
7979+- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
8080+- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
8181+- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
···11+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
22+33+# dependencies
44+/node_modules
55+/.pnp
66+.pnp.js
77+88+# testing
99+/coverage
1010+1111+# next.js
1212+/.next/
1313+/out/
1414+1515+# production
1616+/build
1717+1818+# misc
1919+.DS_Store
2020+*.pem
2121+2222+# debug
2323+npm-debug.log*
2424+yarn-debug.log*
2525+yarn-error.log*
2626+2727+# local env files
2828+.env.local
2929+.env.development.local
3030+.env.test.local
3131+.env.production.local
3232+3333+# vercel
3434+.vercel
+30
apps/docs/README.md
···11+## Getting Started
22+33+First, run the development server:
44+55+```bash
66+yarn dev
77+```
88+99+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1010+1111+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
1212+1313+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
1414+1515+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
1616+1717+## Learn More
1818+1919+To learn more about Next.js, take a look at the following resources:
2020+2121+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
2222+- [Learn Next.js](https://nextjs.org/learn/foundations/about-nextjs) - an interactive Next.js tutorial.
2323+2424+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
2525+2626+## Deploy on Vercel
2727+2828+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_source=github.com&utm_medium=referral&utm_campaign=turborepo-readme) from the creators of Next.js.
2929+3030+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
···11+/// <reference types="next" />
22+/// <reference types="next/image-types/global" />
33+44+// NOTE: This file should not be edited
55+// see https://nextjs.org/docs/basic-features/typescript for more information.
···11+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
22+33+# dependencies
44+/node_modules
55+/.pnp
66+.pnp.js
77+88+# testing
99+/coverage
1010+1111+# next.js
1212+/.next/
1313+/out/
1414+1515+# production
1616+/build
1717+1818+# misc
1919+.DS_Store
2020+*.pem
2121+2222+# debug
2323+npm-debug.log*
2424+yarn-debug.log*
2525+yarn-error.log*
2626+2727+# local env files
2828+.env.local
2929+.env.development.local
3030+.env.test.local
3131+.env.production.local
3232+3333+# vercel
3434+.vercel
+30
apps/web/README.md
···11+## Getting Started
22+33+First, run the development server:
44+55+```bash
66+yarn dev
77+```
88+99+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1010+1111+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
1212+1313+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
1414+1515+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
1616+1717+## Learn More
1818+1919+To learn more about Next.js, take a look at the following resources:
2020+2121+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
2222+- [Learn Next.js](https://nextjs.org/learn/foundations/about-nextjs) - an interactive Next.js tutorial.
2323+2424+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
2525+2626+## Deploy on Vercel
2727+2828+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_source=github.com&utm_medium=referral&utm_campaign=turborepo-readme) from the creators of Next.js.
2929+3030+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
···11+/// <reference types="next" />
22+/// <reference types="next/image-types/global" />
33+44+// NOTE: This file should not be edited
55+// see https://nextjs.org/docs/basic-features/typescript for more information.