Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📄 Docs: Remove the bullet points from the features list in the "About this recipe" section. #228

Merged
82 changes: 56 additions & 26 deletions v2/community/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ hide_title: true
# Introduction

## We offer the following functionality
- ✅ Sign-in / Sign-up with email ID and password
- ✅ Forgot password flow using email
- ✅ Secure session management
- ✅ Email verification
- ✅ Social logins (Google, Facebook, Apple, Github + adding custom providers)
- ✅ Passwordless login

✅ Sign-in / Sign-up with email ID and password <br/>
✅ Forgot password flow using email <br/>
✅ Secure session management <br/>
✅ Email verification <br/>
✅ Social logins (Google, Facebook, Apple, Github + adding custom providers) <br/>
✅ Passwordless login <br/>

## Supported tech stacks

Expand All @@ -21,27 +21,57 @@ You will need to integrate us on your backend and frontend.
:::

### On the backend:
- <span style={{
color: "#31ff64",
fontWeight: "bold"
}}>Implemented - NodeJS, GoLang and Python (FastAPI, Django, Flask)</span>: We support all current functionality (signup, manage auth tokens, social login etc).
- <span style={{
color: "#f72020",
fontWeight: "bold"
}}>Not supported - PHP (Laravel) and Java (Spring)</span>.

- <span
style={{
color: "#31ff64",
fontWeight: "bold",
}}
>
Implemented - NodeJS, GoLang and Python (FastAPI, Django, Flask)
</span>
: We support all current functionality (signup, manage auth tokens, social
login etc).
- <span
style={{
color: "#f72020",
fontWeight: "bold",
}}
>
Not supported - PHP (Laravel) and Java (Spring)
</span>
.{" "}

For unsupported frameworks (such as Laravel and Spring), please submit your request on the [product roadmap page](https://supertokens.com/product-roadmap). Alternatively, you can build and contribute these SDKs with our help. Reach out to us on [Discord](https://supertokens.com/discord).

### On the frontend:
- <span style={{
color: "#31ff64",
fontWeight: "bold"
}}>Implemented - ReactJS</span>: We support all current functionality (signup, manage auth tokens, social login etc).
- <span style={{
color: "#fcc100",
fontWeight: "bold"
}}>Partial support - Vanilla JS, Angular, Vue and React Native </span>: We provide session management only and you would have to build the frontend UI for login.
- <span style={{
color: "#f72020",
fontWeight: "bold"
}}>Not supported - iOS, Android, Flutter</span>.

- <span
style={{
color: "#31ff64",
fontWeight: "bold",
}}
>
Implemented - ReactJS
</span>
: We support all current functionality (signup, manage auth tokens, social
login etc).
- <span
style={{
color: "#fcc100",
fontWeight: "bold",
}}
>
Partial support - Vanilla JS, Angular, Vue and React Native{" "}
</span>
: We provide session management only and you would have to build the frontend
UI for login.
- <span
style={{
color: "#f72020",
fontWeight: "bold",
}}
>
Not supported - iOS, Android, Flutter
</span>
.
17 changes: 11 additions & 6 deletions v2/emailpassword/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,21 @@ title: About this recipe
hide_title: true
---

# About this recipe
# About this recipe

## Features
- ✅ Sign-up / Sign-in with email ID and password
- ✅ Forgot password flow using email
- ✅ Secure session management
- ✅ Email verification

✅ Sign-up / Sign-in with email ID and password <br/>
✅ Forgot password flow using email <br/>
✅ Secure session management <br/>
✅ Email verification <br/>

## Demo app

### View the demo app

[Click here](https://emailpassword.demo.supertokens.com/) to visit the demo app

### View the source code for the demo app (NodeJS + ReactJS)
[Click here](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-emailpassword) to view the source code for the demo app

[Click here](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-emailpassword) to view the source code for the demo app
21 changes: 13 additions & 8 deletions v2/passwordless/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,24 @@ title: About this recipe
hide_title: true
---

# About this recipe
# About this recipe

## Features
- ✅ Sign in / up with OTP or / and magic link via SMS or email
- ✅ Secure session management
- ✅ Customise email or SMS
- ✅ Integrate with your own email / SMS sending service

<!-- - ✅ Automatic email / SMS spam prevention
- ✅ Support for international SMS sending -->
✅ Sign in / up with OTP or / and magic link via SMS or email <br/>
✅ Secure session management <br/>
✅ Customise email or SMS <br/>
✅ Integrate with your own email / SMS sending service <br/>

<!-- ✅ Automatic email / SMS spam prevention <br/>
✅ Support for international SMS sending <br/> -->

## Demo app

### View the demo app

[Click here](https://passwordless.demo.supertokens.com/) to visit the demo app

### View the source code for the demo app (NodeJS + ReactJS)
[Click here](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-passwordless) to view the source code for the demo app

[Click here](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-passwordless) to view the source code for the demo app
16 changes: 10 additions & 6 deletions v2/session/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,19 @@ hide_title: true
---

# About this recipe

## Features:
- ✅ Session management (access token + rotating refresh tokens)
- ✅ Read / Add / Edit user roles in your APIs and the frontend
- ✅ Protect website routes that need authentication
- ✅ Sign out feature
- ✅ Ban / Unban users and revoke sessions

✅ Session management (access token + rotating refresh tokens) <br/>
✅ Read / Add / Edit user roles in your APIs and the frontend <br/>
✅ Protect website routes that need authentication <br/>
✅ Sign out feature <br/>
✅ Ban / Unban users and revoke sessions <br/>

## Security benefits

SuperTokens provides a secure way of handling token based authentication post login. We prevent many session related attack vectors:

- XSS (by using `httpOnly` cookies)
- Minimises damage from access token signing key compromise by automatically changing the keys.
- Minimises damage from session data theft from database, by only storing hashed tokens.
Expand All @@ -32,11 +35,12 @@ You can also find one of the solutions [here](./advanced-customizations/examples
:::

## Overview of session flow

<img src="/img/session_flow.png" />

- After sign in, a new session is created by issuing a refresh and access token to the frontend.
- The frontend sends the access token for each API call that requires session authentication.
- These API calls verify the access token and its expiry. If verification fails, the API throws a session expired error, else, execution continues.
- If an API throws session expired error, the frontend uses its refresh token to get a new refresh and a new access token. This is done via a special API on your backend. If a session has been revoked, this API will also throw session expired after which the user will have to login again.
- After obtaining a new set of tokens, the frontend retries the original API call, yielding the desired result.
- To revoke a session, the backend removes the refresh token and its session information from its database.
- To revoke a session, the backend removes the refresh token and its session information from its database.
12 changes: 8 additions & 4 deletions v2/thirdparty/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@ hide_title: true
# About this recipe

## Features:
- ✅ Sign-up / Sign-in with third party providers (Like google, facebook etc..)
- ✅ Secure session management
- ✅ Email verification

✅ Sign-up / Sign-in with third party providers (Like google, facebook etc..) <br/>
✅ Secure session management <br/>
✅ Email verification <br/>

## Demo App

### View the demo app

[Click here](https://thirdparty.demo.supertokens.com/) to visit the demo app

### View the source code for the demo app (NodeJS + ReactJS)
[Click here](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-thirdparty) to view the source code for the demo app

[Click here](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-thirdparty) to view the source code for the demo app
16 changes: 10 additions & 6 deletions v2/thirdpartyemailpassword/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,21 @@ hide_title: true
---

# About this recipe

## Features:
- ✅ Sign-up / Sign-in with email ID and password
- ✅ Sign-up / Sign-in with third party providers (Like google, facebook etc..)
- ✅ Forgot password flow using email
- ✅ Secure session management
- ✅ Email verification

✅ Sign-up / Sign-in with email ID and password <br/>
✅ Sign-up / Sign-in with third party providers (Like google, facebook etc..) <br/>
✅ Forgot password flow using email <br/>
✅ Secure session management <br/>
✅ Email verification <br/>

## Demo app

### View the demo app

[Click here](https://thirdpartyemailpassword.demo.supertokens.com/) to visit the demo app

### View the source code for the demo app (NodeJS + ReactJS)
[Click here](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-thirdpartyemailpassword) to view the source code for the demo app

[Click here](https://github.com/supertokens/supertokens-auth-react/tree/master/examples/with-thirdpartyemailpassword) to view the source code for the demo app