Skip to content

Commit

Permalink
Merge pull request #509 from auth0/deploy-docs
Browse files Browse the repository at this point in the history
Highlight e2e testing and deployment in README
  • Loading branch information
adamjmcgrath authored Oct 1, 2021
2 parents d298b02 + 02daabe commit a3b6fd1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The Auth0 Next.js SDK is a library for implementing user authentication in Next.
- [Architecture](./ARCHITECTURE.md)
- [Comparison with auth0-react](#comparison-with-the-auth0-react-sdk)
- [Testing](#testing)
- [Deploying](#deploying)
- [Contributing](#contributing)
- [Vulnerability Reporting](#vulnerability-reporting)
- [What is Auth0?](#what-is-auth0)
Expand Down Expand Up @@ -278,6 +279,12 @@ By default, the SDK creates and manages a singleton instance to run for the life

If you're using Jest, we recommend using `jest.resetModules()` after each test. Alternatively, you can look at [creating your own instance of the SDK](./EXAMPLES.md#create-your-own-instance-of-the-sdk), so it can be recreated between tests.

For end to end tests, have a look at how we use a [mock OIDC Provider](./scripts/oidc-provider.js).

# Deploying

For deploying, have a look at [how we deploy our example app to Vercel](./examples/README.md).

## Contributing

We appreciate feedback and contribution to this repo! Before you get started, please read the following:
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,6 @@ AUTH0_BASE_URL=$VERCEL_URL

Unlike other `.env` files, You will need to check in `.env.production` so it should **not** contain any secrets. See how we define `.env.production` in the [kitchen-sink example app](./kitchen-sink-example/.env.production).

###### Production deployments
###### Production deployments (or other environments with fixed urls)

For production deployments or [custom domains assigned to a git branch](https://vercel.com/docs/custom-domains#assigning-a-domain-to-a-git-branch) you should assign the correct url to the `AUTH0_BASE_URL` environment variable in "Settings > Environment Variables". See the [Vercel docs on Environment Variables](https://vercel.com/docs/environment-variables#preview-environment-variables) for more information. This will override your `.env.production` file.

0 comments on commit a3b6fd1

Please sign in to comment.