<

Timothy
Brockman

IT Manager / Code Contributor

@

tel: 1 407 602 7721
Tim@TimBrockman.com
github.com/timBrockman
Meetup.com/members/805108/
LinkedIn.com/in/timbrockman

A good README is important, but it's better to also have a demo. For front-end project's GitHub Pages (gh-pages) can work well for hosting a demo. To only push your ./dist folder to your gh-pages directory, instead of the raw source files use:

git subtree push --prefix dist origin gh-pages

or wrapped as an npm command in a package.json

"scripts": {
  "deploy":"git subtree push --prefix dist origin gh-pages"
}

Other than no server side shenanigans, there are other limitations. GitHub doesn't support HTTP/2 yet. If needed, a CDN like Cloudflare can make your content faster.

A working NPM deploy to gh-pages example