Deployment - Revision history

Admin at 11:54, 10 November 2022

2022-11-10T11:54:43Z

← Older revision		Revision as of 11:54, 10 November 2022
Line 31:		Line 31:

	==='''Installation'''===		==='''Installation'''===
	#~~Either install the MSI file or extract~~ the Zip file to a desired folder.		#Extract the Zip file to a desired folder.
	#In folder, double click "CreateShortcut.bat" which will create a shortcut on Windows desktop. This shortcut actually runs `StartPoetryApp.ps1` which will launch PoetryApp.exe and open the default Web browser browsing [http://localhost:5000 http://localhost:5300].		#In folder, double click "CreateShortcut.bat" which will create a shortcut on Windows desktop. This shortcut actually runs `StartPoetryApp.ps1` which will launch PoetryApp.exe and open the default Web browser browsing [http://localhost:5000 http://localhost:5300].

Line 61:		Line 61:
	=====In Terminal=====		=====In Terminal=====
	#Under "/Users/YourUsername/Documents/PoetryApp", execute "./StartPoetryApp.command". And this will launch PoetryApp as a local service hosting http://localhost:5300 and open browser Safari or Chrome, and go to http://localhost:5300		#Under "/Users/YourUsername/Documents/PoetryApp", execute "./StartPoetryApp.command". And this will launch PoetryApp as a local service hosting http://localhost:5300 and open browser Safari or Chrome, and go to http://localhost:5300
			[[File:PoetryApp Local Service.png\|alt=PoetryApp Local Service\|thumb\|PoetryApp Local Service]]
	=====In Finder=====		=====In Finder=====

	#Double click "StartPoetryApp.command".		#Double click "StartPoetryApp.command".
	~~[[File:PoetryApp Local Service.png\|alt=PoetryApp Local Service\|thumb\|PoetryApp Local Service]]~~
	'''Hints:'''		'''Hints:'''

	You may make an Alias of "StartPoetryApp.command".		You may make an Alias of "StartPoetryApp.command".

Admin: /* MacOS Desktop App */

2022-11-10T05:51:22Z

MacOS Desktop App

← Older revision		Revision as of 05:51, 10 November 2022
Line 51:		Line 51:

	==='''Prerequisites'''===		==='''Prerequisites'''===
	#[https://dotnet.microsoft.com/en-us/download/dotnet/7.0 ASP.NET Core Runtime] for macOS Binaries Arm64 or x64. Optional. If you ~~had installed~~ the self contained release, you don't need to install		#[https://dotnet.microsoft.com/en-us/download/dotnet/7.0 ASP.NET Core Runtime] for macOS Binaries Arm64 or x64 and follow [https://learn.microsoft.com/en-us/dotnet/core/install/macos this article]. Optional. If you install the self contained release, you don't need to install the runtime separately.

	==='''Installation'''===		==='''Installation'''===

Admin at 05:11, 10 November 2022

2022-11-10T05:11:36Z

← Older revision		Revision as of 05:11, 10 November 2022
Line 7:		Line 7:
	=== '''Prerequisites''' ===		=== '''Prerequisites''' ===

	# [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime Hosting Bundle] for Windows IIS.		# [https://dotnet.microsoft.com/en-us/download/dotnet/7.0 ASP.NET Core Runtime Hosting Bundle] for Windows IIS.
	# A Website created with Application Pool of "No Managed Code".		# A Website created with Application Pool of "No Managed Code".

Line 28:		Line 28:

	=== '''Prerequisites'''===		=== '''Prerequisites'''===
	#[https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime] for Windows		#[https://dotnet.microsoft.com/en-us/download/dotnet/7.0 ASP.NET Core Runtime] for Windows

	==='''Installation'''===		==='''Installation'''===
Line 51:		Line 51:

	==='''Prerequisites'''===		==='''Prerequisites'''===
	#[https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime] for macOS Binaries Arm64 or x64. Optional. If you had installed the self contained release, you don't need to install		#[https://dotnet.microsoft.com/en-us/download/dotnet/7.0 ASP.NET Core Runtime] for macOS Binaries Arm64 or x64. Optional. If you had installed the self contained release, you don't need to install

	==='''Installation'''===		==='''Installation'''===

Admin: /* MacOS Desktop App */

2022-10-28T08:26:44Z

MacOS Desktop App

← Older revision		Revision as of 08:26, 28 October 2022
Line 55:		Line 55:
	==='''Installation'''===		==='''Installation'''===
	# Extract the Zip file to a desired folder, for example, "/Users/YourUsername/Documents/PoetryApp"		# Extract the Zip file to a desired folder, for example, "/Users/YourUsername/Documents/PoetryApp"
	#[https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 Apply "chmod 755" to files "StartPoetryApp.sh" and "bin/PoetryApp"] to make both become executable.		#[https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 Apply "chmod 755" to files "StartPoetryApp.command" and "bin/PoetryApp"] to make both become executable.

	===Execution===		===Execution===

	=====In Terminal=====		=====In Terminal=====
	#Under "/Users/YourUsername/Documents/PoetryApp", execute "./StartPoetryApp.sh". And this will launch PoetryApp as a local service hosting http://localhost:5300 and open browser Safari or Chrome, and go to http://localhost:5300		#Under "/Users/YourUsername/Documents/PoetryApp", execute "./StartPoetryApp.command". And this will launch PoetryApp as a local service hosting http://localhost:5300 and open browser Safari or Chrome, and go to http://localhost:5300

	=====In Finder=====		=====In Finder=====

	#Double click "StartPoetryApp.sh".		#Double click "StartPoetryApp.command".
			[[File:PoetryApp Local Service.png\|alt=PoetryApp Local Service\|thumb\|PoetryApp Local Service]]
			'''Hints:'''

	~~[[File:Mac terminal~~.~~png\|alt=mac terminal\|thumb\|mac terminal]]~~		You may make an Alias of "StartPoetryApp.command".

Admin at 10:15, 27 October 2022

2022-10-27T10:15:33Z

← Older revision		Revision as of 10:15, 27 October 2022
Line 24:		Line 24:
	If you don't want to purchase a SSL certificate, you may use "[https://letsencrypt.org/ Let's Encrypt]".		If you don't want to purchase a SSL certificate, you may use "[https://letsencrypt.org/ Let's Encrypt]".

	== Desktop App ==		== Windows Desktop App==
	The releases for desktop app are basically the same as the ones for Web App, however, the release is hosted in a local Web server Kestrel included in ASP.NET Core Runtime.		The releases for desktop app are basically the same as the ones for Web App, however, the release is hosted in a local Web server Kestrel included in ASP.NET Core Runtime.

	=== ~~Windows~~ ===		=== '''Prerequisites'''===
			#[https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime] for Windows

	~~==== '''Prerequisites''' ====~~		==='''Installation'''===
	~~# [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime] for Windows~~		#Either install the MSI file or extract the Zip file to a desired folder.
			#In folder, double click "CreateShortcut.bat" which will create a shortcut on Windows desktop. This shortcut actually runs `StartPoetryApp.ps1` which will launch PoetryApp.exe and open the default Web browser browsing [http://localhost:5000 http://localhost:5300].
	==== '''Installation''' ====
	# Either install the MSI file or extract the Zip file to a desired folder.
	# In folder, double click "CreateShortcut.bat" which will create a shortcut on Windows desktop. This shortcut actually runs `StartPoetryApp.ps1` which will launch PoetryApp.exe and open the default Web browser browsing [http://localhost:5000 http://localhost:5300].

	You can copy or move the shortcut to any launch area of Windows.		You can copy or move the shortcut to any launch area of Windows.
Line 43:		Line 41:

	# File `bin/appsettings.json`: Alter Kestrel/Endpoints/Http/Url to "[http://localhost:Port http://localhost:PortNotInUse]", for example, "[http://localhost http://localhost:5310"]		# File `bin/appsettings.json`: Alter Kestrel/Endpoints/Http/Url to "[http://localhost:Port http://localhost:PortNotInUse]", for example, "[http://localhost http://localhost:5310"]
	# File `StartPoetryApp.ps1`: Alter respective URL of "start-process".		#File `StartPoetryApp.ps1`: Alter respective URL of "start-process".
	'''Remarks:'''		'''Remarks:'''

	* The desktop app's backend is running on Kestrel which does not read web.config with some rewrite rules, and these rules are for entering the app from any valid frontend routes. However, because you almost always enter the frontend the first time through the startup URL, and the service worker of the frontend will then later on take care of the routing. So eventually you later can access the app from any valid frontend routes.		*The desktop app's backend is running on Kestrel which does not read web.config with some rewrite rules, and these rules are for entering the app from any valid frontend routes. However, because you almost always enter the frontend the first time through the startup URL, and the service worker of the frontend will then later on take care of the routing. So eventually you later can access the app from any valid frontend routes.
	* Likewise, the static read only variant (Poetry Viewer) of the app also rely on the service worker for routing. Poetry Viewer is often hosted in a server without explicit backend and you may not have control of the server config for the rewrite rules.		*Likewise, the static read only variant (Poetry Viewer) of the app also rely on the service worker for routing. Poetry Viewer is often hosted in a server without explicit backend and you may not have control of the server config for the rewrite rules.

	=== MacOS ===		==MacOS Desktop App==
	[[File:Local app on MacOS.png\|thumb\|local app on MacOS]]		[[File:Local app on MacOS.png\|thumb\|local app on MacOS]]

	==== '''Prerequisites''' ====		==='''Prerequisites'''===
	# [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime] for macOS Binaries Arm64 or x64. Optional. If you had installed the self contained release, you don't need to install		#[https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime] for macOS Binaries Arm64 or x64. Optional. If you had installed the self contained release, you don't need to install

	==== '''Installation''' ====		==='''Installation'''===
	# Extract the Zip file to a desired folder, for example, "/Users/YourUsername/Documents/PoetryApp"		# Extract the Zip file to a desired folder, for example, "/Users/YourUsername/Documents/PoetryApp"
	# [https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 Apply "chmod 755" to files "StartPoetryApp.sh" and "bin/PoetryApp"] to make both become executable.		#[https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 Apply "chmod 755" to files "StartPoetryApp.sh" and "bin/PoetryApp"] to make both become executable.

	~~==== Execution ====~~

	~~===== Terminal =====~~
	# Under "/Users/YourUsername/Documents/PoetryApp", execute "./StartPoetryApp.sh". And this will launch PoetryApp as a local service hosting http://localhost:5300 and open browser Safari or Chrome, and go to http://localhost:5300

	~~===== Finder =====~~

	~~# Double click "StartPoetryApp.sh".~~

	'''Hints:'''[[File:Mac terminal.png\|alt=mac terminal\|thumb\|mac terminal]]You may want to edit [https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 the shell script] to execute "PoetryApp" which comes with the following content:

	~~<pre style="color: blue">~~
	~~realpath(){~~
	~~[[ $1 = /* ]] && echo "$1" \|\| "$PWD/${1#./}"~~
	}

	~~shPath~~=~~$(realpath "$0")~~		===Execution===
	~~shDir~~=~~$(dirname "shPath")~~

	~~osascript - "shDir" <<EOF~~		=====In Terminal=====
	~~on run argv~~		#Under "/Users/YourUsername/Documents/PoetryApp", execute "./StartPoetryApp.sh". And this will launch PoetryApp as a local service hosting http://localhost:5300 and open browser Safari or Chrome, and go to http://localhost:5300
	~~tell application~~ "~~Terminal~~"
	~~do script (~~"~~cd shDir && bin~~/PoetryApp")
	~~end tell~~
	~~end run~~
	~~EOF~~

	~~echo lauching PoetryApp service & sleep 2~~		=====In Finder=====
	~~open http://localhost:5300~~
	~~echo PoetryApp service and Web browser launched~~
	~~</pre>~~

	~~'''Remarks:'''~~		#Double click "StartPoetryApp.sh".

	~~The shell script launch "PoetryApp" in a Terminal window. However, after closing the window, the app is still running at the background~~.		[[File:Mac terminal.png\|alt=mac terminal\|thumb\|mac terminal]]

Admin at 21:27, 26 October 2022

2022-10-26T21:27:41Z

← Older revision		Revision as of 21:27, 26 October 2022
Line 1:		Line 1:
	This page is for IT administers, Web masters and computer literates who have basic skills of deploying a Website. The files needed are available in the [[Download]] area.		This page is for IT administers, Web masters and computer literates who have basic skills of deploying a Website or unzip a file of a software application. The files needed are available in the '''[[Download]]''' area.

	During development, the frontend and the backend are often running on different hosts. Almost all features of the app could run well in such config, except the locally hosted pictures. The locally hosted pictures are using relative patch in <code>img src</code>, and such constraint is good for static readonly deployment.

	The backend and the fontend should be hosted in the same host. And the DB engine is with Sqlite.		The backend and the fontend should be hosted in the same host. And the DB engine is with Sqlite.
Line 14:		Line 12:
	=== Installation ===		=== Installation ===

	# ~~Either install the MSI file or extract~~ the Zip file to the Website root folder.		# Extract the Zip file to the Website root folder.
	# Alter bin/appsettings.json with `UseHttps: true` to enforce HTTPS.		# Alter bin/appsettings.json with `UseHttps: true` to enforce HTTPS.

Line 70:		Line 68:
	# Double click "StartPoetryApp.sh".		# Double click "StartPoetryApp.sh".

	'''Hints:'''		'''Hints:'''[[File:Mac terminal.png\|alt=mac terminal\|thumb\|mac terminal]]You may want to edit [https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 the shell script] to execute "PoetryApp" which comes with the following content:

	You may want to edit [https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 the shell script] to execute "PoetryApp" which comes with the following content:

	<pre style="color: blue">		<pre style="color: blue">
Line 96:		Line 92:

	'''Remarks:'''		'''Remarks:'''
	~~[[File:Mac terminal.png\|alt=mac terminal\|thumb\|mac terminal]]~~
	The shell script launch "PoetryApp" in a Terminal window. However, after closing the window, the app is still running at the background.		The shell script launch "PoetryApp" in a Terminal window. However, after closing the window, the app is still running at the background.

Admin: /* MacOS */

2022-10-26T10:31:38Z

MacOS

← Older revision		Revision as of 10:31, 26 October 2022
Line 32:		Line 32:

	==== '''Prerequisites''' ====		==== '''Prerequisites''' ====
	# [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime]		# [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime] for Windows

	==== '''Installation''' ====		==== '''Installation''' ====
Line 55:		Line 55:

	==== '''Prerequisites''' ====		==== '''Prerequisites''' ====
	# [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime] for macOS Binaries Arm64 or x64		# [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 ASP.NET Core Runtime] for macOS Binaries Arm64 or x64. Optional. If you had installed the self contained release, you don't need to install

	==== '''Installation''' ====		==== '''Installation''' ====

Admin: /* Terminal */

2022-10-26T09:45:36Z

Terminal

← Older revision		Revision as of 09:45, 26 October 2022
Line 64:		Line 64:

	===== Terminal =====		===== Terminal =====
	# Under "/Users/YourUsername/Documents/PoetryApp", execute "./StartPoetryApp.sh". And this will launch ~~Kestrel Web server~~ hosting http://localhost:5300 and open browser Safari or Chrome, and go to http://localhost:5300		# Under "/Users/YourUsername/Documents/PoetryApp", execute "./StartPoetryApp.sh". And this will launch PoetryApp as a local service hosting http://localhost:5300 and open browser Safari or Chrome, and go to http://localhost:5300

	===== Finder =====		===== Finder =====

Admin: /* Finder */

2022-10-26T09:42:55Z

Finder

← Older revision		Revision as of 09:42, 26 October 2022
Line 75:		Line 75:

	<pre style="color: blue">		<pre style="color: blue">
	cd "$(~~dirname~~ "$0")"		realpath(){
	bin/PoetryApp &		[[ $1 = /* ]] && echo "$1" \|\| "$PWD/${1#./}"
	sleep 2		}

			shPath=$(realpath "$0")
			shDir=$(dirname "shPath")

			osascript - "shDir" <<EOF
			on run argv
			tell application "Terminal"
			do script ("cd shDir && bin/PoetryApp")
			end tell
			end run
			EOF

			echo lauching PoetryApp service & sleep 2
	open http://localhost:5300		open http://localhost:5300
			echo PoetryApp service and Web browser launched
	</pre>		</pre>

Admin: /* Terminal */

2022-10-23T13:09:45Z

Terminal

← Older revision		Revision as of 13:09, 23 October 2022
Line 59:		Line 59:
	==== '''Installation''' ====		==== '''Installation''' ====
	# Extract the Zip file to a desired folder, for example, "/Users/YourUsername/Documents/PoetryApp"		# Extract the Zip file to a desired folder, for example, "/Users/YourUsername/Documents/PoetryApp"
			# [https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 Apply "chmod 755" to files "StartPoetryApp.sh" and "bin/PoetryApp"] to make both become executable.

	==== Execution ====		==== Execution ====

	===== Terminal =====		===== Terminal =====
	# Under "/Users/YourUsername/Documents/PoetryApp", execute "~~dotnet bin~~/~~PoetryApp~~.~~dll~~". And this will launch Kestrel Web server hosting http://localhost:5300		# Under "/Users/YourUsername/Documents/PoetryApp", execute "./StartPoetryApp.sh". And this will launch Kestrel Web server hosting http://localhost:5300 and open browser Safari or Chrome, and go to http://localhost:5300
	~~# Open~~ browser Safari or Chrome, and go to http://localhost:5300
			===== Finder =====

			# Double click "StartPoetryApp.sh".

	'''Hints:'''		'''Hints:'''

	You may want to ~~create~~ [https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 a shell script] to execute "PoetryApp"~~. For example~~:		You may want to edit [https://support.apple.com/en-au/guide/terminal/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/mac/11.0 the shell script] to execute "PoetryApp" which comes with the following content:

	<pre style="color: blue">		<pre style="color: blue">
Line 77:		Line 81:
	</pre>		</pre>

	~~And don~~'~~t forget to~~ [~~https~~:~~//support~~.~~apple.com/en-au/guide/~~terminal~~/apdd100908f-06b3-4e63-8a87-32e71241bab4/2.12/~~mac~~/11.0 apply~~ "~~chmod 755~~" to the ~~sh file and "PoetryApp"]~~.		'''Remarks:'''
			[[File:Mac terminal.png\|alt=mac terminal\|thumb\|mac terminal]]
			The shell script launch "PoetryApp" in a Terminal window. However, after closing the window, the app is still running at the background.