Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

40 lines (24 loc) · 1.43 KB
Raw

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see Auth0's general contribution guidelines

Local development

Install the dependencies and start the development server:

npm install
npm start

This will run a development server at http://localhost:3000 with a simple application that demonstrates the main features of the SDK. When you make changes the development server will live reload.

You can change the default Auth0 tenant and application by editing the domain and clientId in static/index.html

Running the examples

The examples are React applications and an Express API. To run the example apps see the instructions in examples/README.md

Running the unit tests

The unit tests use Jest and are run with:

npm test

Running the integration tests

The integration tests run against the examples, so you must follow the instructions to set up the examples in examples/README.md first.

Then run:

CYPRESS_USER_EMAIL={YOUR USER} CYPRESS_USER_PASSWORD={YOUR PW} npm run test:integration

CYPRESS_USER_EMAIL and CYPRESS_USER_PASSWORD should be the credentials of a user on your Auth0 tenant that has the read:users permissions on the audience you specified when setting up the examples.