Skip to content

Github Pages

Max Zhang edited this page Jul 24, 2022 · 5 revisions

Updating Github Pages

In develop

When running locally (post v5.X.X), http-server is used as a lightweight static HTTP server to run the Neon web app. The root of the server is located at deployment/test-server/.

index.html is served as the default homepage and consequently {page}.html contains other pages. Scripts and other required assets are contained in test-server/Neon-gh/.

NOTE: Neon-gh is built by webpack from typescript files contained outside of test-server, therefore it is not included in the repo out-of-the-box. Run installation and build steps.

The hosted site can be found at localhost:8080.

In gh-pages

Intentionally, the server directory in the develop branch is a one-to-one reflection of gh-pages used to deploy Github Pages.

To update the Neon web app hosted at https://ddmal.music.mcgill.ca/Neon, simply cherry pick updated files from develop in deployment/test-server/ and copy-paste to gh-pages branch.