diff options
Diffstat (limited to 'examples/with-rollup/README.md')
| -rw-r--r-- | examples/with-rollup/README.md | 80 |
1 files changed, 0 insertions, 80 deletions
diff --git a/examples/with-rollup/README.md b/examples/with-rollup/README.md deleted file mode 100644 index 925501c..0000000 --- a/examples/with-rollup/README.md +++ /dev/null @@ -1,80 +0,0 @@ -# Turborepo starter with Rollup - -This is an official starter Turborepo, showing how Turborepo can be used with Rollup for bundling a `ui` package. - -## Using this example - -Run the following command: - -```sh -npx create-turbo@latest -e with-rollup -``` - -## What's inside? - -This Turborepo includes the following packages/apps: - -### Apps and Packages - -- `ui`: a React component library used by the `web` application, compiled with Rollup -- `web`: a [Next.js](https://nextjs.org) app -- `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 -pnpm run build -``` - -### Develop - -To develop all apps and packages, run the following command: - -``` -cd my-turborepo -pnpm run dev -``` - -### Remote Caching - -Turborepo can use a technique known as [Remote Caching](https://turborepo.org/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://turborepo.org/docs/core-concepts/pipelines) -- [Caching](https://turborepo.org/docs/core-concepts/caching) -- [Remote Caching](https://turborepo.org/docs/core-concepts/remote-caching) -- [Scoped Tasks](https://turborepo.org/docs/core-concepts/scopes) -- [Configuration Options](https://turborepo.org/docs/reference/configuration) -- [CLI Usage](https://turborepo.org/docs/reference/command-line-reference) |