From 9dc6e528f5bdbb3e286ec6cbed18891bc0e66f2e Mon Sep 17 00:00:00 2001 From: Jonas Hungershausen Date: Fri, 13 Dec 2024 13:34:12 +0100 Subject: [PATCH] chore: readmes --- examples/nextjs-app-router/README.md | 84 +++++++++++--------------- examples/nextjs-pages-router/README.md | 19 +++++- 2 files changed, 51 insertions(+), 52 deletions(-) diff --git a/examples/nextjs-app-router/README.md b/examples/nextjs-app-router/README.md index 0a7fac56..29cf81a9 100644 --- a/examples/nextjs-app-router/README.md +++ b/examples/nextjs-app-router/README.md @@ -1,49 +1,35 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with -[`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). - -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` - -Open [http://localhost:3000](http://localhost:3000) with your browser to see the -result. - -You can start editing the page by modifying `app/page.tsx`. The page -auto-updates as you edit the file. - -This project uses -[`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) -to automatically optimize and load [Geist](https://vercel.com/font), a new font -family for Vercel. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js - features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out -[the Next.js GitHub repository](https://github.com/vercel/next.js) - your -feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the -[Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) -from the creators of Next.js. - -Check out our -[Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) -for more details. +This is a simple example application using @ory/elements-react & Next.js app +router. + +## Getting started + +1. Sign up for an account at https://console.ory.sh +2. Create a new or use an existing project +3. Go to https://console.ory.sh/projects/current/settings and copy the **API + endpoints** URL +4. Set the `NEXT_PUBLIC_ORY_SDK_URL` to your project's **API endpoints** URL +5. Run `npm install` +6. Run `npm run dev` and open navigate to http://localhost:3000 + +## Features + +- All self-service user flows Ory supports + - [Login](http://localhost:3000/auth/login) + - [Registration](http://localhost:3000/auth/registration) + - [Recovery](http://localhost:3000/auth/recovery) + - [Verification](http://localhost:3000/auth/verification) + - [Settings](http://localhost:3000/settings) +- User Logout + + +> [!WARNING] +> For convinience Ory provides a default "playground" project, that +> can be used to interact with Ory's APIs. It is a public project, that can be +> used by anyone and data can be deleted at any time. Make sure to use a +> dedicated project. + + +## Need help? + +If you have any issues using this examples, or Ory's products, don't hesitate to +reach out via the [Ory Community Slack](https://slack.ory.sh). diff --git a/examples/nextjs-pages-router/README.md b/examples/nextjs-pages-router/README.md index fb1f29fc..4218b4f9 100644 --- a/examples/nextjs-pages-router/README.md +++ b/examples/nextjs-pages-router/README.md @@ -1,4 +1,4 @@ -This is a simple example application using @ory/elements-react & Next.js app +This is a simple example application using @ory/elements-react & Next.js pages router. ## Getting started @@ -9,12 +9,25 @@ router. endpoints** URL 4. Set the `NEXT_PUBLIC_ORY_SDK_URL` to your project's **API endpoints** URL 5. Run `npm install` -6. Run `npm run dev` and open navigate to https://localhost:3000 +6. Run `npm run dev` and open navigate to http://localhost:3000 -> [!WARNING] For convinience Ory provides a default "playground" project, that +## Features + +- All self-service user flows Ory supports + - [Login](http://localhost:3000/auth/login) + - [Registration](http://localhost:3000/auth/registration) + - [Recovery](http://localhost:3000/auth/recovery) + - [Verification](http://localhost:3000/auth/verification) + - [Settings](http://localhost:3000/settings) +- User Logout + + +> [!WARNING] +> For convinience Ory provides a default "playground" project, that > can be used to interact with Ory's APIs. It is a public project, that can be > used by anyone and data can be deleted at any time. Make sure to use a > dedicated project. + ## Need help?