README improvement #57
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@sirdavos47 is attempting to deploy a commit to the fnd Team on Vercel. A member of the Team first needs to authorize it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary: Updated README to include Node/Yarn prerequisites, devcontainer info (Ubuntu 24.04.2 LTS), clearer install/start/build/deploy commands, and a note on using "$BROWSER" to open the site from the container.
Why: Makes onboarding and local development steps explicit for contributors and clarifies how to open the site from a devcontainer.
How to test:
Pull branch and open README in repo root.
Run yarn install then yarn start in the devcontainer.
Verify the server starts and that "$BROWSER" http://localhost:3000 opens the host browser.