create-supertokens-app

create-supertokens-app

create-supertokens-app is a command line tool that lets you quickly setup and explore how SuperTokens integrates with other popular frameworks. You can use it as an educational tool, to learn how SuperTokens works, or as a starting point for your own applications.

Usage

Using npm

Run the tool using the following command

npx create-supertokens-app@latest

Using Bun

Run the tool using the following command

bun create supertokens-app@latest --manager=bun

You can then select the tech stack that is relevant to you.

The tool creates a folder for the created application. You can follow the instructions the tool provides to then start the application.

Additional usage options

When running the tool you can provide additional arguments.

Option	About	Usage
appname	The folder name to be used when creating the application	--appname=my-app
recipe	The type of authentication you want to use	--recipe=emailpassword
frontend	The frontend stack to use for the application	--frontend=react
backend	The backend stack to use for the application	--backend=node
manager	Which package manager to use (npm, yarn, pnpm, bun)	--manager=pnpm
autostart	Whether the CLI should start the project after setting up	--autostart=true
help	Show help	--help
version	Show version	--version
firstfactors	The first factor to use your application	--firstfactors=otp,email
secondfactors	The second factor to use your application	--secondfactors=otp,email
skip-install	Skip installing dependencies	--skip-install=true
providers	The social auth providers to use for your application (if using thirdparty as a factor)	--providers=google,github

Note: use either --recipe or --firstfactors and/or --secondfactors. The --recipe flag is aimed to be used for the interactive mode and for multi-tenant applications primarily.

Contributing

Please refer to the CONTRIBUTING.md file in this repo.

Contact us

For any queries, or support requests, please email us at [e-mail], or join our Discord server.

Authors

Created with :heart: by the folks at SuperTokens.io.