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 😊
- Take a look at How to Contribute to an Open Source Project on GitHub
- Go thorugh the SuperTokens Code of Conduct
- Check our Github Issues to see if someone has already answered your question.
- Join our community on Discord and feel free to ask us your questions
- OS: Linux or macOS
- IDE: Intellij (recommended) or equivalent IDE
- MongoDB
- Setup the
supertokens-core
by following this guide. If you are not modifying thesupertokens-core
repo, then you do not need to fork that. - Start MongoDB on port
27017
, listening tolocahost
or0.0.0.0
. - Create a MongoDB user (if not already exists) with username
root
and passwordroot
- Create a database called
supertokens
. - Fork the
supertokens-mongodb-plugin
repository - Open
modules.txt
in thesupertokens-root
directory and change it so that it looks like (the last line has changed):// put module name like module name,branch name,github username(if contributing with a forked repository) and then call ./loadModules script core,master plugin-interface,master mongodb-plugin,master,<your github username>
- Run
./loadModules
in thesupertokens-root
directory. This will clone your forkedsupertokens-mongodb-plugin
repo. - Follow
the CONTRIBUTING.md
guide from
supertokens-core
repo for modifying and testing.
- Before submitting a pull request make sure all tests have passed
- Reference the relevant issue or pull request and give a clear description of changes/features added when submitting a pull request
- Make sure the PR title follows conventional commits specification
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: