Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.35 KB

README.md

File metadata and controls

31 lines (21 loc) · 1.35 KB
Raw

SuperTokens-Template

This project is a template for implementing a local SuperTokens API with Managed SuperTokens database and Twilio for user verification.

Used Tools

  • Using SuperTokens for authentication
  • Swagger at http://localhost:3000/api-doc with OpenAPI 3.0
  • Using FontAwesome for icons
  • Using Resend for email address verification
  • Using Twilio for phone number verification with SMS
  • TODO: Using a Postgres database with Docker
  • TODO: Using tRPC on some routes

Getting Started

To get started with this project, follow these steps:

  1. Clone the repository: git clone https://github.com/MartinKondor/supertokens-template.git
  2. Install the dependencies: npm install
  3. Configure the environment variables in a .env.local file, see .env.local.example
  4. Start the server: npm run dev
  5. Open http://localhost:3000/auth or http://localhost:3000/api-doc for Swagger UI.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more information.