Skip to content

Commit d188ba9

Browse files
authored
docs: revise README for environment setup and dependencies
Updated instructions for setting up environment variables and installing dependencies.
1 parent 1227300 commit d188ba9

1 file changed

Lines changed: 28 additions & 9 deletions

File tree

README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,31 @@
1616

1717
</div>
1818

19-
Create a `.env` file in the `/config` package and add the following:
20-
21-
```env
22-
BACKEND_PORT="your-backend-port"
23-
JWT_SECRET="your-jwt-secret"
24-
DATABASE_URL="your-database-connection-string"
25-
RESEND_API_KEY="your-resend-api-key"
26-
CLIENT_ID_GITHUB="your-github-client-id"
27-
CLIENT_SECRET_GITHUB="your-github-client-secret"
19+
## 1. Install Dependencies
20+
21+
From the root of the monorepo, install all workspace dependencies :
22+
23+
```bash
24+
pnpm install
25+
```
26+
27+
## 2. Generate Prisma-Client
28+
29+
move to the `/store` package and generate a prisma-client :
30+
31+
```bash
32+
bun run prisma:generate
33+
```
34+
35+
## 3. Environment variables
36+
37+
move to the `/config` package and add your .env :
38+
39+
```bash
40+
BACKEND_PORT=3001
41+
JWT_SECRET=your-jwt-secret
42+
DATABASE_URL=your-database-connection-string
43+
RESEND_API_KEY=your-resend-api-key
44+
CLIENT_ID_GITHUB=your-github-client-id
45+
CLIENT_SECRET_GITHUB=your-github-client-secret
46+
```

0 commit comments

Comments
 (0)