Deploying an Angular App to Github Pages

Github pages is a Github feature that allows you to host a static website or web app for free, and it’s as simple as putting the files in a gh-pages branch of your project’s repository. The Angular CLI makes it even easier to deploy to Github pages.

This post covers Angular 2 and up

It’s really as simple as one command really:

$ ng github-pages:deploy

And done! Your app will now be hosted at

You can also optionally add a message to the commit when deploying:

$ ng github-pages:deploy --message "First deploy"

And finally, if you’re deploying to a Github user/organization page instead of a project page:

$ ng github-pages:deploy --user-page

Single-page web app fix

👉 See this post from Back Halley Coder for a fix if you’re having issues with directing all traffic to the index.html. Basically the fix is a simple script that uses Session Storage and a meta tag in the 404.html file that redirects to index.html and contains the data for the url that the user was trying to access.

✖ Clear

🕵 Search Results

🔎 Searching...