Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 4.84 KB

CONTRIBUTING.md

File metadata and controls

120 lines (81 loc) · 4.84 KB
Raw

Contributing

We're so excited you're interested in helping with SuperTokens! We are happy to help you get started, even if you don't have any previous open-source experience 😊

New to Open Source?

  1. Take a look at How to Contribute to an Open Source Project on GitHub
  2. Go through the SuperTokens Code of Conduct

Where to ask Questions?

  1. Check our Github Issues to see if someone has already answered your question.
  2. Join our community on Discord and feel free to ask us your questions

Development Setup

Prerequisites

  • OS: Linux or macOS
  • Nodejs & npm
  • IDE: VSCode(recommended) or equivalent IDE

Project Setup

  1. Please setup supertokens-core by following this guide. If you are not contributing to supertokens-core, please skip steps 1 & 4 under "Project Setup" section.
  2. git clone https://github.com/supertokens/supertokens-auth-react.git, supertokens-auth-react and supertokens-root should exist side by side within the same parent directory.
  3. cd supertokens-auth-react
  4. Install the project dependencies 
    npm run init
  5. Add git pre-commit hooks 
    npm run set-up-hooks

Modifying Code

  1. Open the supertokens-auth-react project in your IDE.
  2. You can start modifying the code.
  3. After modification, you need to build the project: 
    npm run build-pretty
  4. Make sure the linter passes: 
    npm run lint

Testing

  1. Navigate to the supertokens-root repository

  2. Start the testing environment

    ./startTestEnv --wait

  3. In a new terminal, navigate to the supertokens-auth-react repository.

  4. Setup node server for testing.

    cd ./test/server/
npm i -d
npm i git+https://github.com:supertokens/supertokens-node.git

  5. Set OAuth secrets

    • Make sure you copy test/.env.example.js to test/.env.js and add correct values.
    • Make sure you copy test/server/.env.example to test/server/.env and add correct values.
    • To get them, please contact the SuperTokens team.

  6. Open a new terminal in supertokens-auth-react and run all tests

    npm run test

Screenshots

You can set the SCREENSHOT_ROOT env var to a path to automatically save screenshots of failing e2e tests. This will save screenshots of failing test into subdirectories of SCREENSHOT_ROOT where the subdirectory identifies the test file and the file names of the screenshots identifying the test title and the

SCREENSHOT_ROOT=test_report npm run test

Run the test application.

  1. npm run start

Note: To test different recipes you need to update the value of authRecipe in local storage. For example thirdpartyemailpassword would result in that recipe being used. If there is no value for authRecipe set, the Email Password recipe is used by default

Note: You need to restart the test app after code changes in the library to see their effects.

Linking supertokens-auth-react to a local demo

You need to run the commands in this script. The command is supposed to be run from the demo app folder which contains the node_modules in which you want to link the library. You will have to modify the script to:

  • Change the ../../../supertokens-auth-react everywhere to point to where the supertokens-auth-react folder exists.
  • Change cd ../users/multi-tenancy-mfa/frontend/ to navigate from supertokens-auth-react to the example app folder on your machine.

Pull Request

  1. Before submitting a pull request make sure all tests have passed
  2. Reference the relevant issue or pull request and give a clear description of changes/features added when submitting a pull request
  3. Make sure the PR title follows conventional commits specification

SuperTokens Community

SuperTokens is made possible by a passionate team and a strong community of developers. If you have any questions or would like to get more involved in the SuperTokens community you can check out:

Additional resources you might find useful: