rsnext/examples/with-supertokens/README.md
Marcos Bérgamo c3e5caf110
docs(examples): improve DX while copying command to create new project (#38410)
* docs(examples): improve DX while copy command to create new project

* chore: apply code review

Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-07-26 21:57:48 -05:00

28 lines
1,023 B
Markdown

# SuperTokens Example
This is a simple set up for applications protected by SuperTokens.
## How to use
- Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
```bash
npx create-next-app --example with-supertokens with-supertokens-app
```
```bash
yarn create next-app --example with-supertokens with-supertokens-app
```
```bash
pnpm create next-app --example with-supertokens with-supertokens-app
```
- Run `yarn install`
- Run `npm run dev` to start the application on `http://localhost:3000`.
## Notes
- Take a look at [SuperTokens documentation](https://supertokens.io/docs/community/introduction).
- We have provided development OAuth keys for the various in build third party providers in the `.env` file. Feel free to use them for development purposes, but **please create your own keys for production use**.