Skip to content

Commit

Permalink
docs: Detail front-end development instructions
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
EBoisseauSierra committed Apr 27, 2022
1 parent c13c947 commit 014a55a
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,15 @@ There are three types of assets you can build:

#### Webpack dev server

The dev server by default starts at `http://localhost:9000` and proxies the backend requests to `http://localhost:8088`. It's possible to change these settings:
The dev server by default starts at `http://localhost:9000` and proxies the backend requests to `http://localhost:8088`.

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`,
3. access `http://localhost:9000` in your browser. (This will load the hot-reloading front-end assets from web-pack while redirecting back-end queries to Flask/Superset.)

It's possible to change these settings:

```bash
# Start the dev server at http://localhost:9000
Expand Down

0 comments on commit 014a55a

Please sign in to comment.