docs: Update README.md to facilitate easier local deployment #8
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
- update README to explain how to run the app locally with `react-scripts` and avoid any issues they may encounter trying to build and then run the build locally, facilitating a more lightweight setup for local usage and experimentation.
hesreallyhim
commented
Mar 2, 2025
| This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details. Use of this software requires attribution to the original author and project, as detailed in the license.ChC |
There was a problem hiding this comment.
Suggested change
| This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details. Use of this software requires attribution to the original author and project, as detailed in the license.ChC | |
| This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details. Use of this software requires attribution to the original author and project, as detailed in the license. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Some (Windows) users have reported issues trying to run the local build using the
npmscriptnpm start. I suspect this is due to a configuration quirk involvingcaddy/nixpaths/railway.Fix
react-scripts(without requiring the app to build) and avoid any issues they may encounter trying to build and then run the build locally, facilitating a more lightweight setup for local usage and experimentation. The appropriatepackage.jsonscript already existed underdev, so this advises users to runnpm run devif they just want local usage or experimentation.