-
Notifications
You must be signed in to change notification settings - Fork 14.1k
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: Detail front-end development instructions #19870
Conversation
Automatically done using the Markdown-All-In-One extension for VSCode: https://open-vsx.org/extension/yzhang/markdown-all-in-one Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
Based on the silly error that led to [this discussion](https://apache-superset.slack.com/archives/C014LS99C1K/p1650969237848999), we clarify that when modifying the front-end locally, one should access the Webpack dev servers, rather than Flask directly, to see the latest changes take effect. Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
a3320f9
to
014a55a
Compare
CONTRIBUTING.md
Outdated
Concretely, it means that you will want to: | ||
|
||
1. [run Superset locally](#flask-server) using Flask, on port `8088`, | ||
2. in parallel, run the Webpack dev server locally on port `9000`, |
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.
Not sure if this is a good place to mention that you can run npm run dev
or (what most people do) npm run dev-server
for hot reloading
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.
Thanks! Would that make things clearer?
Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
ed265f3
to
94aab8f
Compare
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.
Thanks for this, and sorry for the lag in revisiting it! Feel free to ping folks if we neglect to circle back to things :D
* chore: Beautify CONTRIBUTING Automatically done using the Markdown-All-In-One extension for VSCode: https://open-vsx.org/extension/yzhang/markdown-all-in-one Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io> * docs: Detail front-end development instructions Based on the silly error that led to [this discussion](https://apache-superset.slack.com/archives/C014LS99C1K/p1650969237848999), we clarify that when modifying the front-end locally, one should access the Webpack dev servers, rather than Flask directly, to see the latest changes take effect. Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io> * docs: Underline typical workflow Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
* chore: Beautify CONTRIBUTING Automatically done using the Markdown-All-In-One extension for VSCode: https://open-vsx.org/extension/yzhang/markdown-all-in-one Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io> * docs: Detail front-end development instructions Based on the silly error that led to [this discussion](https://apache-superset.slack.com/archives/C014LS99C1K/p1650969237848999), we clarify that when modifying the front-end locally, one should access the Webpack dev servers, rather than Flask directly, to see the latest changes take effect. Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io> * docs: Underline typical workflow Signed-off-by: Étienne Boisseau-Sierra <etienne.boisseau-sierra@unipart.io>
SUMMARY
Based on the silly error that led to this
discussion,
we clarify that when modifying the front-end locally, one should access
the Webpack dev servers, rather than Flask directly, to see the latest
changes take effect.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
n/a
TESTING INSTRUCTIONS
n/a
ADDITIONAL INFORMATION