From e45b751c6c90c58746e880c293886cba94b1b8c1 Mon Sep 17 00:00:00 2001 From: rmoralp Date: Mon, 26 Dec 2022 22:10:20 +0100 Subject: [PATCH] feat: update root docs --- README.md | 74 ++++--------------------------------------------------- turbo.md | 48 ++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 69 deletions(-) create mode 100644 turbo.md diff --git a/README.md b/README.md index c211a3f..4d2b344 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,9 @@ -# Turborepo starter - -This is an official npm starter turborepo. +# Maons ## What's inside? -This turborepo uses [npm](https://www.npmjs.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 -npm run build -``` - -### Develop - -To develop all apps and packages, run the following command: - -``` -cd my-turborepo -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 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: +A huge amount of isolated packages ready to combine and help you to create a project asap. -- [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) +### Packages +- `@maons/lint`: `eslint` configurations (includes `Next.js`, `React.js` and `Prettier` rules) +- `@maons/tsconfig`: `tsconfig.json` files for `Node.js`, `Next.js` and `React.js` projects. diff --git a/turbo.md b/turbo.md new file mode 100644 index 0000000..17456cf --- /dev/null +++ b/turbo.md @@ -0,0 +1,48 @@ + +### Build + +To build all apps and packages, run the following command: + +``` +cd my-turborepo +npm run build +``` + +### Develop + +To develop all apps and packages, run the following command: + +``` +cd my-turborepo +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 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)