Skip to content

Commit

Permalink
update instructions to switch base-href configurations between dev an…
Browse files Browse the repository at this point in the history
…d prod
  • Loading branch information
arpitnarechania committed Sep 18, 2024
1 parent 09685c3 commit 0c8ef6d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,8 @@ A Showcase of Applications Developed using ProvenanceWidgets.
- `npm run build` outputs the build in the `./dist/` folder.

## Deployment
- GitHub Actions is setup via the `.github/workflows/build.yaml` file. Built files are pushed to `gh-pages` branch and served via GitHub Pages at [https://provenancewidgets.github.io/showcase](https://provenancewidgets.github.io/showcase).
- GitHub Actions is setup via the `.github/workflows/build.yaml` file. Built files are pushed to `gh-pages` branch and served via GitHub Pages at [https://provenancewidgets.github.io/showcase](https://provenancewidgets.github.io/showcase).

## Development vs. Building Configurations for base-href
- Development: Because the app served from `/` while developing locally, index.html must be configured with `<base href="/" />`.
- Build: Because the app is eventually served from `/showcase` (and not `/`), index.html must be configured with `<base href="/showcase/" />`. In addition, we pass `--base-href /showcase/` in the `ng build` command (already configured to do this as part of `npm run build`, see package.json).

0 comments on commit 0c8ef6d

Please sign in to comment.