Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
0xPilou committed Sep 10, 2022
1 parent b3b70e7 commit b376592
Showing 1 changed file with 5 additions and 36 deletions.
41 changes: 5 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ This turborepo uses [Yarn](https://classic.yarnpkg.com/) as a package manager. I

### 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`)
- `smart-contracts`: a [Hardhat](https://hardhat.org/) project
- `web`: a [Next.js](https://nextjs.org) app
- `ui`: a stub React component library used by both `web` and other potential Next.js applications
- `lint`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `web3-config` : [Typechain] (https://github.com/dethcrypto/TypeChain) configuration containing the smart-contract interface and deployments files
- `tsconfig`: `tsconfig.json`s used throughout the monorepo

Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
Expand All @@ -29,7 +30,6 @@ This turborepo has some additional tools already setup for you:
To build all apps and packages, run the following command:

```
cd my-turborepo
yarn run build
```

Expand All @@ -38,36 +38,5 @@ yarn run build
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://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)

0 comments on commit b376592

Please sign in to comment.