|
1 |
| -# Turborepo starter |
| 1 | +<a href="https://www.npmjs.com/package/chain" > |
| 2 | + <img alt="Chain Hero Image" src="https://raw.githubusercontent.com/b-bot/chain/main/chain.jpg"> |
| 3 | +</a> |
2 | 4 |
|
3 |
| -This is an official starter Turborepo. |
| 5 | +# Chain |
4 | 6 |
|
5 |
| -## Using this example |
| 7 | +**The fastest way to add web3 functionality to your Next.js application.** |
6 | 8 |
|
7 |
| -Run the following command: |
| 9 | +🔶 Work In Progress 🔶 |
8 | 10 |
|
9 |
| -```sh |
10 |
| -npx create-turbo@latest |
11 |
| -``` |
12 |
| - |
13 |
| -## What's inside? |
14 |
| - |
15 |
| -This Turborepo includes the following packages/apps: |
16 |
| - |
17 |
| -### Apps and Packages |
| 11 | +--- |
18 | 12 |
|
19 |
| -- `docs`: a [Next.js](https://nextjs.org/) app |
20 |
| -- `web`: another [Next.js](https://nextjs.org/) app |
21 |
| -- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications |
22 |
| -- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) |
23 |
| -- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo |
| 13 | +## Getting Started |
24 | 14 |
|
25 |
| -Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). |
26 |
| - |
27 |
| -### Utilities |
28 |
| - |
29 |
| -This Turborepo has some additional tools already setup for you: |
| 15 | +```bash |
| 16 | +npm install chain |
| 17 | +``` |
30 | 18 |
|
31 |
| -- [TypeScript](https://www.typescriptlang.org/) for static type checking |
32 |
| -- [ESLint](https://eslint.org/) for code linting |
33 |
| -- [Prettier](https://prettier.io) for code formatting |
| 19 | +OR |
34 | 20 |
|
35 |
| -### Build |
| 21 | +```bash |
| 22 | +yarn add chain |
| 23 | +``` |
36 | 24 |
|
37 |
| -To build all apps and packages, run the following command: |
| 25 | +OR |
38 | 26 |
|
| 27 | +```bash |
| 28 | +pnpm add chain |
39 | 29 | ```
|
40 |
| -cd my-turborepo |
41 |
| -pnpm build |
42 |
| -``` |
43 |
| - |
44 |
| -### Develop |
45 | 30 |
|
46 |
| -To develop all apps and packages, run the following command: |
| 31 | +## Documentation |
47 | 32 |
|
48 |
| -``` |
49 |
| -cd my-turborepo |
50 |
| -pnpm dev |
51 |
| -``` |
| 33 | +Coming soon. |
52 | 34 |
|
53 |
| -### Remote Caching |
| 35 | +## Releases |
54 | 36 |
|
55 |
| -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. |
| 37 | +Please see versions on [NPM](https://www.npmjs.com/package/chain). |
56 | 38 |
|
57 |
| -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: |
| 39 | +## Contributing |
58 | 40 |
|
59 |
| -``` |
60 |
| -cd my-turborepo |
61 |
| -npx turbo login |
62 |
| -``` |
| 41 | +Please follow our [contributing guidelines](./.github/CONTRIBUTING.md). |
63 | 42 |
|
64 |
| -This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). |
| 43 | +## Authors |
65 | 44 |
|
66 |
| -Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: |
| 45 | +- Byron Polley ([@b_b0t](https://twitter.com/b_b0t)) |
67 | 46 |
|
68 |
| -``` |
69 |
| -npx turbo link |
70 |
| -``` |
| 47 | +--- |
71 | 48 |
|
72 |
| -## Useful Links |
| 49 | +## License |
73 | 50 |
|
74 |
| -Learn more about the power of Turborepo: |
| 51 | +Licensed under the MIT License, Copyright © 2022-present [b-bot](https://byronpolley.com). |
75 | 52 |
|
76 |
| -- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks) |
77 |
| -- [Caching](https://turbo.build/repo/docs/core-concepts/caching) |
78 |
| -- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) |
79 |
| -- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering) |
80 |
| -- [Configuration Options](https://turbo.build/repo/docs/reference/configuration) |
81 |
| -- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference) |
| 53 | +See [LICENSE](./LICENSE) for more information. |
0 commit comments