Skip to content

Latest commit

 

History

History
86 lines (68 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

86 lines (68 loc) · 3.7 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. Clone the forked repository in the parent directory of the previously setup supertokens-root. That is, supertokens-website and supertokens-root should exist side by side within the same parent directory.
  3. cd supertokens-website
  4. Install the project dependencies 
    npm i -d
  5. Add git pre-commit hooks 
    npm run set-up-hooks

Modifying Code

  1. Open the supertokens-website project in your IDE.
  2. You can start modifying the code.
  3. After modification, you need to build the project: 
    npm run build-pretty

Testing

  1. Navigate to the supertokens-root repository

  2. Start the testing environment

    ./startTestingEnv --wait

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

  4. Start a node server required for testing

    cd ./test/server/
npm i -d
npm i git+https://github.com:supertokens/supertokens-node.git
TEST_MODE=testing INSTALL_PATH=../../../supertokens-root NODE_PORT=8082 node .

  5. Open a new terminal in supertokens-website and run all tests

    INSTALL_PATH=../supertokens-root npm test

  6. If all tests pass the output should be:

    Website tests passing

NOTE: When running macOS Monterey or higher, if you get the following error when running the tests:

Error: getaddrinfo ENOTFOUND localhost.org

Make sure that you have an entry for 127.0.0.1 localhost.org in your /etc/hosts file.

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: