Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 1.06 KB

Contributing guide

Setup dev env

npm i --dev

Start server for local testing

npm run start

This will start the server on http://localhost:3000, and the bundle can be accessed on http://localhost:3000/static/js/bundle.js

Now you can create an example angular / vue app using npx create-supertokens-app@latest and change the bundle location in the code from the jsdeliver one to the local one to test it out.

Build

npm run build

Release a new version

  • Make sure to modify the supertokens-auth-react version in package.json to an exact version
  • npm i
  • Run ./release.sh: This will build, create and push a tag with the format of vX.Y.Z that corresponds to the supertokens-auth-react version in package.json
  • Create a new release on GitHub.

Modifying an existing version

  • JSDelivery does not remove older URLs, so we can safely modify existing tags
  • Remove existing tag in remote: git push origin --delete vX.Y.Z
  • Remove existing tag locally: git tag -d vX.Y.Z
  • Run ./release.sh
  • Modify the release on GitHub.