|
1 | | -# Turborepo starter |
| 1 | +# How to implement a backend with Effect |
| 2 | +`@effect/platform` provides a type safe API for building backend apps. Any runtime, any database, and with all the features you expect from a TypeScript backend. |
2 | 3 |
|
3 | | -This Turborepo starter is maintained by the Turborepo core team. |
4 | | - |
5 | | -## Using this example |
6 | | - |
7 | | -Run the following command: |
8 | | - |
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 |
18 | | - |
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 |
24 | | - |
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: |
30 | | - |
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 |
34 | | - |
35 | | -### Build |
36 | | - |
37 | | -To build all apps and packages, run the following command: |
38 | | - |
39 | | -``` |
40 | | -cd my-turborepo |
41 | | -pnpm build |
42 | | -``` |
43 | | - |
44 | | -### Develop |
45 | | - |
46 | | -To develop all apps and packages, run the following command: |
47 | | - |
48 | | -``` |
49 | | -cd my-turborepo |
50 | | -pnpm dev |
51 | | -``` |
52 | | - |
53 | | -### Remote Caching |
54 | | - |
55 | | -> [!TIP] |
56 | | -> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache). |
57 | | -
|
58 | | -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. |
59 | | - |
60 | | -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?utm_source=turborepo-examples), then enter the following commands: |
61 | | - |
62 | | -``` |
63 | | -cd my-turborepo |
64 | | -npx turbo login |
65 | | -``` |
66 | | - |
67 | | -This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). |
68 | | - |
69 | | -Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: |
70 | | - |
71 | | -``` |
72 | | -npx turbo link |
73 | | -``` |
74 | | - |
75 | | -## Useful Links |
76 | | - |
77 | | -Learn more about the power of Turborepo: |
78 | | - |
79 | | -- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks) |
80 | | -- [Caching](https://turbo.build/repo/docs/core-concepts/caching) |
81 | | -- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) |
82 | | -- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering) |
83 | | -- [Configuration Options](https://turbo.build/repo/docs/reference/configuration) |
84 | | -- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference) |
| 4 | +> [**Check out the full article**](https://www.typeonce.dev/article/how-to-implement-a-backend-with-effect) to learn how to get started 🚀 |
0 commit comments