Skip to content

Commit 8c1cfdb

Browse files
committed
chore: add .dev.vars.example and update README with environment setup instructions
1 parent fe5b537 commit 8c1cfdb

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

.dev.vars.example

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
ENVIRONMENT = "development" # development | production
2+
3+
APP_URL = "http://localhost:5173"
4+
SESSION_SECRET = "3ebc25b381e87193f29ffea6b6d380dd"
5+
6+
GITHUB_CLIENT_ID = "..."
7+
GITHUB_CLIENT_SECRET = "..."
8+
9+
GOOGLE_CLIENT_ID = "..."
10+
GOOGLE_CLIENT_SECRET = "..."
11+
12+
RESEND_API_KEY = "..."

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ An introductory starter kit for building applications with React Router v7 (Remi
2626

2727
## Demo
2828

29-
Heres a preview of the app:
29+
Here's a preview of the app:
3030

3131
<div style="display: flex;">
3232
<img src="./.assets/login.png" width="45%" />
@@ -60,6 +60,14 @@ npm install
6060

6161
### Development
6262

63+
First, copy the .dev.vars.example file and rename it to .dev.vars:
64+
65+
```bash
66+
cp .dev.vars.example .dev.vars
67+
```
68+
69+
Update the environment variables in the .dev.vars file according to your needs. These variables will be used by Wrangler during local development.
70+
6371
Run an initial database migration:
6472

6573
```bash

0 commit comments

Comments
 (0)