CONTRIBUTING.md

Contributing

PR and issues are welcomed!

Testing your changes in an external app

You have made some changes to the code and you want to test them in your app before submitting a pull request?

Assuming you/my-app have oidc-spa as a dependency.

cd ~/github
git clone https://github.com/you/my-app
cd my-app
yarn

cd ~/github
git clone https://github.com/garronej/oidc-spa
cd oidc-spa
yarn
yarn build
yarn link-in-app my-app
npx tsc -w

# Open another terminal

cd ~/github/my-app
rm -rf node_modules/.cache
yarn start # Or whatever my-app is using for starting the project

You don't have to use ~/github as reference path. Just make sure my-app and oidc-spa are in the same directory.

Note for the maintainer: You might run into issues if you do not list all your singleton dependencies in src/link-in-app.js -> singletonDependencies. A singleton dependency is a dependency that can only be present once in an App. Singleton dependencies are usually listed as peerDependencies example react, @emotion/*.