-
Notifications
You must be signed in to change notification settings - Fork 436
chore: update dependencies and improve README for React authentication example #2356
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
base: master
Are you sure you want to change the base?
Conversation
vinckr
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, thanks!
a few small formatting etc nits to resolve then can be merged imo
|
|
||
| This project demonstrates how to integrate Ory authentication into a React | ||
| application built with Vite and TypeScript. | ||
| This example demonstrates how to implement authentication in a React.js |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| This example demonstrates how to implement authentication in a React.js | |
| This example demonstrates how to implement authentication in a React |
nit but I think the official name is React, also see https://react.dev/
| - An Ory Network account with a project set up | ||
| - Your Ory Project ID | ||
|
|
||
| ## Getting Started |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ## Getting Started | |
| ## Get started |
please always use sentence casing and active form in headings - see README.md
|
|
||
| ## Getting Started | ||
|
|
||
| ### 1. Install Dependencies |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### 1. Install Dependencies | |
| ### 1. Install dependencies |
| ``` | ||
|
|
||
| # Start the development server | ||
| ### 2. Start the Application |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### 2. Start the Application | |
| ### 2. Start the application |
| used as the `baseUrl` in the Ory SDK configuration. | ||
| used as the `basePath` in the Ory SDK configuration. | ||
|
|
||
| ## Making API Calls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ## Making API Calls | |
| ## Making API calls |
| The API server runs on port 8081 and requires the proper session cookies from | ||
| Ory to authenticate requests. | ||
|
|
||
| ## Project Structure |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ## Project Structure | |
| ## Project structure |
| - `src/AppWithApi.tsx` - Authentication with API integration example | ||
| - `src/api/index.js` - Express.js API server example | ||
|
|
||
| ## Available Scripts |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ## Available Scripts | |
| ## Available scripts |
|
|
||
| This guide shows how to create a simple React application and secure it with authentication powered by Ory. You can use this guide | ||
| with both Ory Network and self-hosted Ory software. | ||
| This guide shows how to create a simple React native application and secure it with authentication powered by Ory. You can use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| This guide shows how to create a simple React native application and secure it with authentication powered by Ory. You can use | |
| This guide shows how to create a simple React Native application and secure it with authentication powered by Ory. You can use |
| `App.tsx` code below). The `--dev` flag disables security checks for easier integration and should not be used when running the | ||
| Tunnel in an insecure environment like public networks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| `App.tsx` code below). The `--dev` flag disables security checks for easier integration and should not be used when running the | |
| Tunnel in an insecure environment like public networks. | |
| `App.tsx` code below). The `--dev` flag disables security checks for easier integration and shouldn't be used when running Ory Tunnel in an insecure environment like public networks. |
Related Issue or Design Document
Checklist
If this pull request addresses a security vulnerability,
I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
Further comments