diff --git a/.env.example b/.env.example index b89da41826..18b5d0a06a 100644 --- a/.env.example +++ b/.env.example @@ -1,3 +1,5 @@ +# Rename file to .env and populate values +# to be able to run tests NEXTAUTH_URL=http://localhost:3000 NEXTAUTH_TWITTER_ID= NEXTAUTH_TWITTER_SECRET= diff --git a/.env.local.example b/.env.local.example new file mode 100644 index 0000000000..232db5d2c9 --- /dev/null +++ b/.env.local.example @@ -0,0 +1,6 @@ +# Rename file to .env.local and populate values +# to be able to run the dev app +NEXTAUTH_URL=http://localhost:3000 +SECRET= +GITHUB_ID= +GITHUB_SECRET= \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08458ddca5..26a1df2528 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,11 +38,12 @@ npm i 3. Populate `.env.local`: - Copy `.env.example` to `.env.local`, and add your env variables for each provider you want to test. + Copy `.env.local.example` to `.env.local`, and add your env variables for each provider you want to test. ->NOTE: You can configure providers of the dev app in `pages/api/auth/[...nextauth].js` +> NOTE: You can add any environment variables to .env.local that you would like to use in your dev app. +> You can find the next-auth config under`pages/api/auth/[...nextauth].js`. -4. Start the dev application/server and CSS watching: +1. Start the dev application/server and CSS watching: ```sh npm run dev ```