Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 1.16 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 test: Run the unit tests
  • npm run test:watch: Run the unit tests and watch for changes
  • npm run install:example: Install the examples
  • Setup the examples https://github.com/auth0/nextjs-auth0/tree/main/example-app
  • npm run start:example: Run the example
  • npm run test:example: Run the E2E tests (you will need to populate the CYPRESS_USER_EMAIL and CYPRESS_USER_PASSWORD env vars)
  • npm run test:example:watch: Run the E2E tests and watch for changes

Running examples against a mock openid provider

  • start:example-local: Run the example app with a mock openid provider
  • test:example-local: Run the E2E tests with a mock openid provider
  • test:example-local:watch: Run the E2E tests with a mock openid provider and watch for changes