Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 1.63 KB
Raw

Contribution

Please read Auth0's contribution guidelines.

Environment setup

  • Make sure you have node and npm installed
  • Run npm install to install dependencies
  • Follow the local development steps below to get started

Local development

  • npm install: install dependencies
  • npm run build: Build the binary
  • npm run build:test: Do this once to build the test harness for the tests
  • npm test: Run the unit tests
  • npm run test:watch: Run the unit tests and watch for changes
  • npm run install:examples: Install the examples
  • Setup the examples https://github.com/auth0/nextjs-auth0/tree/main/examples
  • npm run start:basic: Run the basic example
  • npm run start:kitchen-sink: Run the kitchen sink example
  • npm run test:kitchen-sink: Run the E2E tests (you will need to populate the CYPRESS_USER_EMAIL and CYPRESS_USER_PASSWORD env vars)
  • npm run test:kitchen-sink:watch: Run the E2E tests and watch for changes

Running examples against a mock openid provider

Your env vars in /examples/kitchen-sink-example/.env.local should look like

AUTH0_SECRET=#ANY LONG RANDOM VALUE
AUTH0_ISSUER_BASE_URL=http://localhost:3000/oidc
AUTH0_BASE_URL=http://localhost:3000
AUTH0_CLIENT_ID=testing
AUTH0_CLIENT_SECRET=testing

Then run one of the commands:

  • start:kitchen-sink-local: "npm run dev:local --prefix=examples/kitchen-sink-example",
  • test:kitchen-sink-local: Run the E2E tests against a mock openid provider
  • test:kitchen-sink-local:watch: Run the E2E tests against a mock openid provider and watch for changes