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: update react quickstart example #2085

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

christiannwamba
Copy link
Contributor

@christiannwamba christiannwamba commented Mar 28, 2025

Related Issue or Design Document

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact [email protected]) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

christiannwamba and others added 2 commits April 2, 2025 15:27
Copy link
Member

@aeneasr aeneasr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mermaid

Screenshot 2025-04-07 at 10 24 25

@christiannwamba
Copy link
Contributor Author

@aeneasr not sure I understand. Does not look broken. Unless you are referring to something else

@christiannwamba
Copy link
Contributor Author

Ah nevermind. I see it now

@christiannwamba
Copy link
Contributor Author

Fixed here: #2104

@christiannwamba christiannwamba requested a review from aeneasr April 8, 2025 07:21
Copy link
Member

@jonas-jonas jonas-jonas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay - LGTM!

Copy link
Member

@vinckr vinckr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @christiannwamba, what a nice upgrade to the guide!

I tried to follow it "braindead", basically just copying and pasting the commands and following the written instructions.
I think its really important that the guide works if you do it this way without any issues - as soon as you have some little error people already get frustrated.

See my comments in that light - I think it just needs to be super smooth, so please be as specific as possible and have everything in a copy&paste-able state

it's 95% there, just need to smooth out a few small things!

page! Let's click on sign up and create your first user.
### See it in action

Access your react app at [localhost:5173](http://localhost:8081/), sign in, and see if you can make authenticated requests to your
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Access your react app at [localhost:5173](http://localhost:8081/), sign in, and see if you can make authenticated requests to your
Access your react app at [localhost:5173](http://localhost:5173/), sign in, and see if you can make authenticated requests to your

I think there is a typo here?
What exactly should I do here as a user - create an account? / how do I make an authenticated request to the API? its not really obvious to me from this part of the guide.

For example when I sign-up I get redirect to localhost:4000 with an error

{"error":{"code":"404","details":{"ruleId":"6176b3cb"},"message":"Invalid path","reason":"No resource found using the specified path.","status":"Not Found"}}

I think it would be good to include very specific instructions here, that I can follow "braindead" and also a curl command to test the API auth part.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants