Skip to content

Commit 9d413e5

Browse files
authored
docs: update Readme.md (#112)
1 parent 6e682df commit 9d413e5

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

.env.example

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ ENCRYPTION_KEY=""
22
DATABASE_URL="postgresql://easy-invoice:easy-invoice@localhost:7406/easy-invoice"
33
GOOGLE_CLIENT_ID=""
44
GOOGLE_CLIENT_SECRET=""
5+
GOOGLE_REDIRECT_URI="http://localhost:3000/login/google/callback"
56
CURRENT_ENCRYPTION_VERSION="v1"
67
REQUEST_API_URL=""
78
REQUEST_API_KEY=""

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,17 @@ cd easy-invoice
3434
cp .env.example .env
3535
```
3636

37-
3. Fill in the required environment variables in `.env`:
37+
3. You need to manually create an API key on the Request API, either via our Open API reference or the API portal.
38+
39+
4. After your API key is created, register your easy invoice webhook URL at Request API, either via our Open API reference or the API portal. The default Easy Invoice webhook URL when running locally is `http://localhost:3000/api/webhook`.
40+
41+
5. Fill in the required environment variables in `.env`:
3842

3943
- `DATABASE_URL`: Your PostgreSQL connection string
4044
- `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`: Google OAuth credentials
41-
- `REQUEST_API_KEY`: Your Request Network API key
45+
- `GOOGLE_REDIRECT_URI`: your google login redirect url, when running locally it should be `http://localhost:3000/login/google/callback`
46+
- `REQUEST_API_KEY`: The key created in step 3 (starts with `rn_...`)
47+
- `WEBHOOK_SECRET`: The webhook secret from step 4
4248
- `REQUEST_API_URL`: Request Network API URL
4349
- `NEXT_PUBLIC_REOWN_PROJECT_ID`: Your Reown project ID
4450
- Other required environment variables as specified in `.env.example`

0 commit comments

Comments
 (0)