Skip to content

Commit e706f7f

Browse files
authored
Docs: Update README.md docs on setting up (#16)
1 parent 118bba9 commit e706f7f

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

project/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
4040
- [TypeScript](https://www.typescriptlang.org/) for static type checking
4141
- [ESLint](https://eslint.org/) for code linting
4242
- [Prettier](https://prettier.io) for code formatting
43+
- [TurboRepo](https://turbo.build/repo/docs) for easily managing monorepo
4344
- [shadcn/ui](https://ui.shadcn.com/) for CSS
4445
- [Zod](https://zod.dev/) for validation
46+
- [TanStack Query](https://tanstack.com/query/latest/docs/framework/react/overview) for querying
4547

4648
## Getting Started
4749

@@ -53,6 +55,17 @@ To build all apps and packages, run the following command:
5355
pnpm build
5456
```
5557

58+
### Setup Environment Variables
59+
60+
Each `project/apps` has a `.env` that you should create.
61+
Copy the `.env.example` file in each of these apps to create a new `.env` file:
62+
63+
```bash
64+
$ cp .env.example .env
65+
```
66+
67+
Then, replace the variables accordingly.
68+
5669
### Develop
5770

5871
To develop all apps and packages, run the following command:

0 commit comments

Comments
 (0)