Deployment for Poetry Viewer

From Poetry MP Wiki
Jump to navigation Jump to search

Static Read Only Website (Poetry Viewer)

PoetryApp can become a static read only Website, serving as a poetry viewer online or locally, without a Web service backend. The poems data is exported into JSON files using the full app. Such deployment makes a static content Website has rich user interfaces and user interactions, including search functions. Poetry Viewer conforms to Progress Web App (PWA), thus after being installed as a local app, and the poetry content is cached locally.

Server Requirements

Basically any Web server like IIS, Apache and NGINX etc. that could serve HTML, JavaScript, JSON and image files should be fine. In addition to create your own or rent one in DC or Cloud, many ISPs provide a free Website or Web page storage for each customer, which support FTP upload.

Full app files structure

Client Device Requirements

The GUI of the app is composed through HTML5 and JavaScript, requiring not too old devices, as listed below.

iOS

iPhone X and iOS 14 or above.

iPad 5 and iOS 14 or above.

Android

Andoid 7

Windows PC

Windows 7, latest Chrome and Firefox.

Mac

Catalian, Safari 13.1, Chrome 104

Yosemite, Chrome 87

Files

The installation of Poetry MP takes around 36 MB in disk size. After removing folder "bin" and folder "PoetryApp_Data", the JavaScript files and other assets take around 3 MB.

View Files Structure

Hints:

Please check https://github.com/zijianhuang/poets/tree/gh-pages/docs for basic structure.

Configuration

The following files may be modified:

  • index.html
  • conf/siteconfig.js
  • conf/manifest.json
  • conf/favicon.png
  • conf/fonts.css


The initial site title is "Poetry Collection" as defined in the title tag of index.html. And the site title can also be declared in siteconfig.js as "siteName" which will render the site title in HTML dynamically.

Example 1: conf/siteconfig.js for George Gordon Byron Poetry Demo Page

const SITE_CONFIG = {
	siteName: 'Byron Collection',
	staticReadonly: true,
	staticDatas: [
		{filename: 'Byron'},
	]
}
Byron poems

And file "Byron.JSON" should be located at folder "data". Since the SPA is not hosted in a Website root but a sub folder "byron", in "index.html", make sure tag base/href point to this, like:

<base href="/byron/">

This is important for the page to load the JavaScript files of the SPA correctly. If you host the SPA at the Website root, you may have:

<base href="/">

Poetry Viewer conforms to Progress Web App (PWA), and the app is accompanied with file "conf/manifest.json". Example 2: for Chinese Poetry of Li Bai with 2 writing systems

Libai poems in traditional Chinese writing
const SITE_CONFIG = {
	siteName: '李白诗集',
	staticReadonly: true,
	staticDatas: [
		{filename: 'primary', secondaryFilename: 'secondary'}
	]
}
Libai poems in simplified Chinese writing

Both "primary.json" and "secondary.json" should be in folder "data". Example 3: for multiple poets at demo page

const SITE_CONFIG = {
	siteName: 'Poetry Collections',
	staticReadonly: true,
	staticDatas: [
		{filename: 'Shelley', poetName: 'Percy Bysshe Shelley'},
		{filename: 'Byron', poetName: 'George Gordon Byron'},
		{filename: 'EdgarAllanPoe', poetName: 'Edgar Allan Poe'},
		{filename: 'LiBai', poetName: '李白', secondaryFilename: 'LiBai2nd'}
	]	
}
poets

Deploy to ISP Provided Website

An ISP often by default provides a customer with the such Website or Home Pages Service:

Generally you may use FTP to upload your static contents to there. For more details of uploading, please refer to the instructions provided by your ISP.

ISP gives you a Website

Good luck. The SPA codes should be working right away at http://YourUserName.superisp.com.

And changing "index.html" and "manifest.json" may become just optional

If your SPA shouldn't be your home page content, you may want the access URL to your SPA to be such: http://YourUserName.superisp.com/MySPA.

  1. Create folder MySPA under the Web root.
  2. Modify "index.html" and "manifest.json" as shown in the examples above.
  3. Upload the SPA static contents.

ISP give you a path to a Website shared by all users

To host your SPA at http://users.isp.com/YourUserName, modify "index.html" and "manifest.json" as shown in the examples above.

To host your SPA at http://users.isp.com/YourUserName/MySPA, modify the base tag of index.html to <base href="/YourUserName/MySPA/"> and do similar things to "manifest.json"

Deploy to GitHub Pages

GitHub gives you are Website like https://YourUserName.github.io. Each repository may have a home page like https://YourUserName.github.io/repo1 and https://YourUserName.github.io/repo2 and so on. For more details of uploading, please check: https://pages.github.com/ or https://docs.github.com/en/pages.

The following descriptions assume that you have read the GitHub Pages manual, and the repository gh-pages is already in place.

Steps:

  1. Copy the build to branch gh-pages of the repository.
  2. Modify index.html and ensure <base href="/poems/"> or alike, and modify "manifest.json" accordingly.
  3. Commit and push.
  4. Test. It may take Github.io a few dozen seconds to reflect the changes just being pushed.

Deploy to Azure Static Web Apps

An instance of Azure Static Web Apps give you a Website, and the free tier gives you around 0.5GB storage according to https://azure.microsoft.com/en-us/pricing/details/app-service/static/

Assuming you will be Deploying to Azure Static Web App through GitHub Actions, you may prepare the content:

Steps:

  1. Copy the build to branch azure-pages repository.
  2. Modify index.html and ensure <base href="/">if you would deploy the app to the Website root.
  3. Commit and push.

The following steps outlines only a few key steps of deploying, and you should read respective manual of Microsoft Azure Static Web Apps.

Steps to deploy:

  1. In "Create Static Web App", choose a name, such as "poets".
  2. In "Deployment Details/Source", choose GitHub, and select respective organization, repository and branch, such as "azure-pages".
  3. In "Build Details/Build Presets", select "Custom", and in "App Location", select "appcontent" if you had copied the scripts to here rather than the repository's root.

A few minutes after the deployment is done, the app should appear in the URL of the static Web app. For example, at https://thankful-grass-0793a2d1e.2.azurestaticapps.net/

Remarks:

  • Microsoft's free tier is basically a free trial for up to 12 months. "When you sign up for an Azure free account, you get a Free Trial subscription, which provides you $200 Azure credit in your billing currency for 30 days and 12 months of free services. " @ https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/subscription-disabled
  • If you have a paid account of Visual Studio or Office 365, it seems the free tier of the static app is included.

References:

Deploy to AWS S3 Bucket

Please check https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteHosting.html first for detailed steps.

For example: http://fonlow.heroes.s3-website-us-east-1.amazonaws.com/

AWS Provide the following means to publish:

  1. Web UI the S3 console
  2. REST API. This could be used automatic deployment from client sides.
  3. AWS SDKs
  4. AWS CLI

Remarks:

  • "As part of the AWS Free Tier, you can get started with Amazon S3 for free. Upon sign-up, new AWS customers receive 5GB of Amazon S3 storage in the S3 Standard storage class; 20,000 GET Requests; 2,000 PUT, COPY, POST, or LIST Requests; and 100 GB of Data Transfer Out each month." @ https://aws.amazon.com/s3/pricing/?p=ft&c=wa&z=2

And NO HTTPS access.

Good enough for the SPA which requires loading basically once.

Deploy to Google Cloud Bucket as a Web page or Website

As described in "Host a static website", without your own custom domain, you could have only static Web page content become publicly accessible, and the access URL have to be directly to index.html or alike, even if you have assigned MainPageSuffix with index.html.

Assuming you have read and followed "Host a static website" and you don't associate your own custom domain with the bucket, then to access the SPA you will have to use a URL like

https://storage.googleapis.com/poets_bucket/index.html

And URL like https://storage.googleapis.com/poets_bucket will have Google Cloud Bucket to return an XML content listing all files in the bucket. If you don't like such listing, you may change principal "allUsers" to role "Storage Legacy Object Reader", then Google Cloud Bucket will return XML with error message "Access denied".

Remarks:

Google Cloud Bucket is free for only one year.

Casual App Fontend Update

  1. Clear all files in root
  2. Copy index.html, *.js, ngsw.json and styles*.css.
  3. Optionally alter base href in index.html to "/poems/" or alike.

If there are changes in assets, copy things accordingly.

Customize Styles After Deployment

conf/font.css is not among the NG build process and is referenced in index.html directly. This is an interface for customization of some sections of the app.

You can introduce new fonts and new styles to respective sections through altering font.css and copying some font files (WOFF2 typically) under assets/fonts.

Prepare Poetry Contents

Please check Maintenance#Export.

SEO

In Index.html, There is a script section like:

<script type="application/ld+json">
    {
    "@context": "http://schema.org",
    "@type": "WebApplication",
    "description": "Poetry collection",
    "keywords": "Poetry,Poems,Poet,Muse",
    "browserRequirements": "requires HTML5 support",
    }
</script>

Web spiders will pick up this and make appropriate indexing.

Summary of Customization

The above sections had introduced various customization during deployment and after build. This section gives a summary.

Index.html

Element base/href

If you deploy in a sub folder under the Web root, you need to alter the value of this element every time a new build comes in.

Element title

The value of title is shown in the browser tab as site title. However, the value defined in this element will be replaced by setting "siteName" defined in "conf/siteconfig.js" unless the setting is not defined. Since index.html is altered in every build, it is generally better to custom site title with setting siteName, though when the index.html page is loaded you may see the title defined in index.html for a few milliseconds then the one defined in siteconfig.js. When a new build comes in, generally you don't want to alter what in folder "conf".

conf/favicon.png

You may want to define your own favicon.

conf/fonts.css

You may want to custom some fonts being used in the frontend.

conf/manifest.json

If you expect your readers to install the app as a PWA app, you may alter the following settings, otherwise, just leave the file alone.

  • name: presented when OS or Web browser prompts for installation of the PWA.
  • short_name: used as the label of the shortcut icon.
  • description
  • id: Unique ID to represent an instance of PoetryApp or Poetry Viewer. So when the app is updated and "name" or "short_name" is changed, the OS or the browser may recognize the same instance through this ID.

conf/siteconfig.js

siteName

If defined, this will overwrite the site title defined in index.html. If you want to customize the site title, this is the setting you should use.

staticReadonly

When true, the site is static read only, no Web service backend needed.

staticDatas

Being used when staticReadonly is true, this setting provides a reference to JSON files located in folder data, and the filenames in the index should not include the file extension name "json".

copyPoemEnabled

Enable a button to copy the content of a poem to clipboard.

copyAlbumEnabled

Enable a button to copy the content of an album to clipboard.

actionsAlign

Valid values: 'start', 'center' and 'end'. The default is 'end'. This defines the align of action buttons at the bottom of a dialogbox.

smallScreenBreakpoint

Value values: 'Small' and 'XSmall'. The default is 'XSmall', representing a handset. By default, if the screen size is considered small, the gap between the toolbar button is narrower, and the sidebar will hide by default after selecting an item. If the expected poetry content has long lines, value 'Small' is more appropriate, so the sidebar will be less likely hiding the content.

localeId

By default, the app uses the default locale of the Web browser. For example, in Google Chrome, if the top language of Settings/Languages is English (United Kingdom), the app will follow format dd/mm/yyyy. You may enforce certain date format through setting "localeId", for example, with "en-AU". Please check "Language-Region Designators".

Retrieved from "https://poetryappwiki.fonlow.org/w/index.php?title=Deployment_for_Poetry_Viewer&oldid=258"