Skip to content

Commit 7f670c5

Browse files
committed
docs: clarify .env usage in CONTRIBUTING.md [skip release] (#1085)
1 parent b1a99ec commit 7f670c5

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

.env.example

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Rename file to .env and populate values
2+
# to be able to run tests
13
NEXTAUTH_URL=http://localhost:3000
24
NEXTAUTH_TWITTER_ID=
35
NEXTAUTH_TWITTER_SECRET=

.env.local.example

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Rename file to .env.local and populate values
2+
# to be able to run the dev app
3+
NEXTAUTH_URL=http://localhost:3000
4+
SECRET=
5+
GITHUB_ID=
6+
GITHUB_SECRET=

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,12 @@ npm i
3838

3939
3. Populate `.env.local`:
4040

41-
Copy `.env.example` to `.env.local`, and add your env variables for each provider you want to test.
41+
Copy `.env.local.example` to `.env.local`, and add your env variables for each provider you want to test.
4242

43-
>NOTE: You can configure providers of the dev app in `pages/api/auth/[...nextauth].js`
43+
> NOTE: You can add any environment variables to .env.local that you would like to use in your dev app.
44+
> You can find the next-auth config under`pages/api/auth/[...nextauth].js`.
4445
45-
4. Start the dev application/server and CSS watching:
46+
1. Start the dev application/server and CSS watching:
4647
```sh
4748
npm run dev
4849
```

0 commit comments

Comments
 (0)