You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-8Lines changed: 18 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,15 +14,15 @@
14
14
<p>Using a combination of npm, UNPKG, and Github Pages covers nearly all of these requirements!</p>
15
15
<ul>
16
16
<li><b><ahref="https://www.npmjs.com/">npm</a>:</b> The software registry stores the the static assets in
17
-
versioned, immutable packages.</li>
17
+
versioned, immutable packages. <i>Perfect for managing the immutable assets!</i></li>
18
18
<br />
19
19
<li><b><ahref="https://unpkg.com/#/">UNPKG</a>:</b> The CDN makes all assets of the packages on npm addressable
20
20
over https
21
-
and globally available.</li>
21
+
and globally available. <i>Perfect for delivering the immutable assets!</i></li>
22
22
<br />
23
23
<li><b><ahref="https://pages.github.com/">GitHub Pages</a>:</b> This static hosting site supports easy
24
24
configuration of DNS and HTTPS, has great integration with GitHub (obviously), and has a short TTL for
25
-
browser caching</li>
25
+
browser caching. <i>Perfect for serving the deployment manifest!</i></li>
26
26
</ul>
27
27
<h2><i>This Immutable Web App is hosted using npm, UNPKG, and GitHub Pages!</i></h2>
28
28
<h3>Project Structure</h3>
@@ -35,18 +35,18 @@ is split into two critical branches:
35
35
<br />
36
36
<li><a href="https://github.com/ImmutableWebApps/unpkg-immutable-example/tree/master"><code>master</code></a> is
37
37
configured to serve the GitHub Pages site. It only contains a single file <a href="https://github.com/ImmutableWebApps/unpkg-immutable-example/blob/master/404.html"><code>404.html</code></a>.
38
-
This single file is served for every request made to the GitHub Pages site.</li>
38
+
This single file is <a href="https://help.github.com/articles/creating-a-custom-404-page-for-your-github-pages-site/">served for every request</a> made to the GitHub Pages site.</li>
39
39
</ul>
40
40
<h3>Project Lifecycle</h3>
41
41
<h4>Building</h4>
42
-
<p>Developing this web application is the same as any other Angular project. Features are built and tested locally, commits and
42
+
<p>Developing this web application is the same as any other single-page app node project. Features are built and tested locally, commits and
43
43
pull requests advance the state of the codebase. When a stable version of the app is ready to be deployed, the
44
44
assets are rendered to the <code>/dist</code> folder using <code>npm run build</code> and new version of the
45
-
project is published to npm using <code>npm publish</code>. The assets become available on <a href="https://unpkg.com/@immutablewebapps/unpkg-immutable-example@0.0.1/">UNPKG</a>.</p>
45
+
project is published to npm using <code>npm publish</code>. The assets become available on <a href="https://unpkg.com/@immutablewebapps/unpkg-immutable-example/">UNPKG</a>.</p>
46
46
<h4>Deploying</h4>
47
47
<p>With the new version of the assets available on UNPKG, an <i>atomic</i> deployment can be triggered by
48
-
switching to the <code>master</code> branch and updating <code>404.html</code> with the new references to project
49
-
assets via UNPKG and any related changes to environment variables. Once the commit is made, GitHub Pages
48
+
switching to the <code>master</code> branch and updating <code>404.html</code> with the references to the new project
49
+
assets and any changes to environment variables. Once the commit is is pushed to the GitHub repository, GitHub Pages
50
50
deployment is triggered and the new version of the web application is available.</p>
51
51
<h2><i>Deployments!</i></h2>
52
52
<p>With our Immutable Web App hosted by npm/UNPKG and without any environment-specific configuration, deployments
@@ -71,3 +71,13 @@ is split into two critical branches:
<p><i>and configure it however you want! Try loading up some <ahref="https://github.com/ImmutableWebApps/unpkg-immutable-example/releases">older versions!</a></i></p>
is where the Angular project is maintained. It was generated from Angular CLI and is maintained like
35
-
any other static web application.</li>
36
-
<br/>
37
-
<li><ahref="https://github.com/ImmutableWebApps/unpkg-immutable-example/tree/master"><code>master</code></a> is
38
-
configured to serve the GitHub Pages site. It only contains a single file <ahref="https://github.com/ImmutableWebApps/unpkg-immutable-example/blob/master/404.html"><code>404.html</code></a>.
39
-
This single file is served for every request made to the GitHub Pages site.</li>
40
-
</ul>
41
-
<h3>Project Lifecycle</h3>
42
-
<h4>Building</h4>
43
-
<p>Developing this web application is the same as any other Angular project. Features are built and tested locally, commits and
44
-
pull requests advance the state of the codebase. When a stable version of the app is ready to be deployed, the
45
-
assets are rendered to the <code>/dist</code> folder using <code>npm run build</code> and new version of the
46
-
project is published to npm using <code>npm publish</code>. The assets become available on <ahref="https://unpkg.com/@immutablewebapps/unpkg-immutable-example@0.0.1/">UNPKG</a>.</p>
47
-
<h4>Deploying</h4>
48
-
<p>With the new version of the assets available on UNPKG, an <i>atomic</i> deployment can be triggered by
49
-
switching to the <code>master</code> branch and updating <code>404.html</code> with the new references to project
50
-
assets via UNPKG and any related changes to environment variables. Once the commit is made, GitHub Pages
51
-
deployment is triggered and the new version of the web application is available.</p>
52
-
<h2><i>Deployments!</i></h2>
53
-
<p>With our Immutable Web App hosted by npm/UNPKG and without any environment-specific configuration, deployments
54
-
are cheap and reliable! Let's deploy <code>index.html</code> to wherever it is easiest to setup DNS and HTTPS!</p>
55
-
<h3>Deploy to another Github Pages repository</h3>
56
-
<p><i>and let's change the version!</i></p>
57
-
<ul>
58
-
<li>Create a <ahref="https://github.com/new">new Github repo</a></li>
59
-
<li><ahref="https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/">Configure the
60
-
repo as a publishing source for Github Pages</a></li>
61
-
<li>Commit the <code>index.html</code> as a <ahref="https://help.github.com/articles/creating-a-custom-404-page-for-your-github-pages-site/">custom
configured to serve the GitHub Pages site. It only contains a single file <ahref="https://github.com/ImmutableWebApps/unpkg-immutable-example/blob/master/404.html"><code>404.html</code></a>.
44
+
This single file is <ahref="https://help.github.com/articles/creating-a-custom-404-page-for-your-github-pages-site/">served
45
+
for every request</a> made to the GitHub Pages site.</li>
46
+
</ul>
47
+
<h3>Project Lifecycle</h3>
48
+
<h4>Building</h4>
49
+
<p>Developing this web application is the same as any other single-page app node project. Features are built
50
+
and tested locally, commits and
51
+
pull requests advance the state of the codebase. When a stable version of the app is ready to be deployed,
52
+
the
53
+
assets are rendered to the <code>/dist</code> folder using <code>npm run build</code> and new version of
54
+
the
55
+
project is published to npm using <code>npm publish</code>. The assets become available on <ahref="https://unpkg.com/@immutablewebapps/unpkg-immutable-example/">UNPKG</a>.</p>
56
+
<h4>Deploying</h4>
57
+
<p>With the new version of the assets available on UNPKG, an <i>atomic</i> deployment can be triggered by
58
+
switching to the <code>master</code> branch and updating <code>404.html</code> with the references to the
59
+
new project
60
+
assets and any changes to environment variables. Once the commit is is pushed to the GitHub repository,
61
+
GitHub Pages
62
+
deployment is triggered and the new version of the web application is available.</p>
63
+
<h2><i>Deployments!</i></h2>
64
+
<p>With our Immutable Web App hosted by npm/UNPKG and without any environment-specific configuration,
65
+
deployments
66
+
are cheap and reliable! Let's deploy <code>index.html</code> to wherever it is easiest to setup DNS and
67
+
HTTPS!</p>
68
+
<h3>Deploy to another Github Pages repository</h3>
69
+
<p><i>and let's change the version!</i></p>
70
+
<ul>
71
+
<li>Create a <ahref="https://github.com/new">new Github repo</a></li>
0 commit comments