Skip to content

Commit 0db5938

Browse files
committed
update readme
1 parent 71d6848 commit 0db5938

File tree

2 files changed

+9
-49
lines changed

2 files changed

+9
-49
lines changed

project/README.md

Lines changed: 8 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,22 @@
1-
# Turborepo starter
2-
3-
This is an official starter Turborepo.
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?
1+
## Layout
142

153
This Turborepo includes the following packages/apps:
164

17-
### Apps and Packages
5+
### Apps
186

19-
- `docs`: a [Next.js](https://nextjs.org/) app
207
- `web`: another [Next.js](https://nextjs.org/) app
8+
- `api-gateway`: [NestJS](https://nestjs.com/) backend serving as an entry point into microservices
9+
- `questions-service`: [NestJS](https://nestjs.com/) backend handling all questions related functions.
10+
11+
### Packages
12+
2113
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
2214
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
2315

2416
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
2517

2618
### Utilities
2719

28-
This Turborepo has some additional tools already setup for you:
29-
3020
- [TypeScript](https://www.typescriptlang.org/) for static type checking
3121
- [ESLint](https://eslint.org/) for code linting
3222
- [Prettier](https://prettier.io) for code formatting
@@ -36,7 +26,6 @@ This Turborepo has some additional tools already setup for you:
3626
To build all apps and packages, run the following command:
3727

3828
```
39-
cd my-turborepo
4029
pnpm build
4130
```
4231

@@ -45,36 +34,6 @@ pnpm build
4534
To develop all apps and packages, run the following command:
4635

4736
```
48-
cd my-turborepo
37+
pnpm install
4938
pnpm dev
5039
```
51-
52-
### Remote Caching
53-
54-
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.
55-
56-
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:
57-
58-
```
59-
cd my-turborepo
60-
npx turbo login
61-
```
62-
63-
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
64-
65-
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
66-
67-
```
68-
npx turbo link
69-
```
70-
71-
## Useful Links
72-
73-
Learn more about the power of Turborepo:
74-
75-
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
76-
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
77-
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
78-
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
79-
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
80-
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)

project/apps/questions-service/src/questions.service.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ export class QuestionsService {
88
];
99

1010
findById(id: string) {
11+
console.log('hello');
1112
return this.questions.find((question) => question.id === id);
1213
}
1314
}

0 commit comments

Comments
 (0)