Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

23 lines (18 loc) · 1.02 KB

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