AppSuite:GettingStarted 7.4.2 - Revision history

Khgras at 10:01, 22 May 2017

2017-05-22T10:01:08Z

← Older revision		Revision as of 10:01, 22 May 2017
Line 81:		Line 81:
	Once you are sure that your setup works, you can extend the example and write the actual code for your app. Keep in mind that after [[#Writing \| writing your code]], you will always need to [[#Building \| build the app]] and have your [[#Hosting the app \| Appserver]] running in the background, but don't need to restart it after every build.		Once you are sure that your setup works, you can extend the example and write the actual code for your app. Keep in mind that after [[#Writing \| writing your code]], you will always need to [[#Building \| build the app]] and have your [[#Hosting the app \| Appserver]] running in the background, but don't need to restart it after every build.

	While developing always keep in mind, that there is an [~~[AppSuite~~:~~Debugging_the_UI \|~~ article about debugging the user interface]] which helps you avoid and fix typical errors.		While developing always keep in mind, that there is an [https://documentation.open-xchange.com/latest/ui/miscellaneous/debugging.html article about debugging the user interface] which helps you avoid and fix typical errors.

	== Packaging ==		== Packaging ==

Khgras at 09:32, 22 May 2017

2017-05-22T09:32:27Z

← Older revision		Revision as of 09:32, 22 May 2017
Line 47:		Line 47:
	</pre>		</pre>

	and <tt>apps/com.example/manifest.json</tt> for the [~~[AppSuite~~:~~UI_manifests_explained \|~~ manifest]] which tells the UI that your app exists and what to do with it:		and <tt>apps/com.example/manifest.json</tt> for the [https://documentation.open-xchange.com/latest/ui/customize/manifests.html manifest] which tells the UI that your app exists and what to do with it:

	<pre class="language-javascript">{ "namespace": "core" }</pre>		<pre class="language-javascript">{ "namespace": "core" }</pre>

Tierlieb: Tierlieb moved page AppSuite:GettingStarted to AppSuite:GettingStarted 7.4.2

2014-05-05T15:10:22Z

Tierlieb moved page AppSuite:GettingStarted to AppSuite:GettingStarted 7.4.2

← Older revision

Revision as of 15:10, 5 May 2014

Viktor.Pracht: /* Installing the Development Tools */

2013-11-25T13:53:20Z

Installing the Development Tools

← Older revision		Revision as of 13:53, 25 November 2013
Line 13:		Line 13:
	First, you need to install some tools which are necessary for UI development. For now, the simplest way is to download the source of the OX App Suite UI. Since the source code is kept in a [http://git-scm.com/ Git] repository, you will need <tt>git</tt> to download it:		First, you need to install some tools which are necessary for UI development. For now, the simplest way is to download the source of the OX App Suite UI. Since the source code is kept in a [http://git-scm.com/ Git] repository, you will need <tt>git</tt> to download it:

	$ git clone --depth ~~1 -b release-7.4.~~1 https://code.open-xchange.com/git/wd/frontend/web		$ git clone --depth 1 https://code.open-xchange.com/git/wd/frontend/web

	This downloads the latest version and unpacks it into a subdirectory called <tt>web</tt> in the current directory.		This downloads the latest version and unpacks it into a subdirectory called <tt>web</tt> in the current directory.

	The option <tt>--depth 1</tt> prevents the download of the entire history, and reduces the download size from hundreds of MB to less than 20MB~~. The option <tt>-b release-7.4.1</tt> specifies a git branch. The full functionality described in this article is only available in the branch <tt>release-7.4.1</tt> until 7.4.1 is released~~.		The option <tt>--depth 1</tt> prevents the download of the entire history, and reduces the download size from hundreds of MB to less than 20MB.

	The tools which you will need are contained in the directory <tt>ui/bin</tt>. To simplify their use, you should add this directory to your <tt>$PATH</tt>:		The tools which you will need are contained in the directory <tt>ui/bin</tt>. To simplify their use, you should add this directory to your <tt>$PATH</tt>:

John.broomfield: /* Further Reading */

2013-11-14T17:42:42Z

Further Reading

← Older revision		Revision as of 17:42, 14 November 2013
Line 165:		Line 165:
	* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.		* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* You can read this to get a better overview [[AppSuite:Developing for the UI \| developing the user inferface]].		* You can read this to get a better overview of [[AppSuite:Developing for the UI \| developing the user inferface]].

John.broomfield: /* Further Reading */

2013-11-14T17:42:13Z

Further Reading

← Older revision		Revision as of 17:42, 14 November 2013
Line 165:		Line 165:
	* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.		* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* To get a better overview ~~about~~ [[AppSuite:Developing for the UI \| developing the user inferface]].		* You can read this to get a better overview [[AppSuite:Developing for the UI \| developing the user inferface]].

John.broomfield: /* Further Reading */

2013-11-14T17:41:14Z

Further Reading

← Older revision		Revision as of 17:41, 14 November 2013
Line 162:		Line 162:

	== Further Reading ==		== Further Reading ==
	* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] for developing for OX App Suite.		* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there are [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] for developing for OX App Suite.
	* It's highly recommended ~~to gain more knowledge about~~ all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] ~~are providing~~ you for ~~developing~~ OX App Suite.		* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* ~~Get~~ a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].		* To get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].

John.broomfield: /* Further Reading */

2013-11-14T17:39:08Z

Further Reading

← Older revision		Revision as of 17:39, 14 November 2013
Line 162:		Line 162:

	== Further Reading ==		== Further Reading ==
	* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] ~~how you can develop~~ for OX App Suite.		* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] for developing for OX App Suite.
	* It's highly recommended to gain more knowledge about all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] are providing you for developing OX App Suite.		* It's highly recommended to gain more knowledge about all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] are providing you for developing OX App Suite.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* Get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].		* Get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].

John.broomfield: /* Further Reading */

2013-11-14T17:38:20Z

Further Reading

← Older revision		Revision as of 17:38, 14 November 2013
Line 162:		Line 162:

	== Further Reading ==		== Further Reading ==
	* ~~You~~ just ~~build~~ your first app for OX App Suite, keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] how you can develop for OX App Suite.		* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] how you can develop for OX App Suite.
	* It's highly recommended to gain more knowledge about all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] are providing you for developing OX App Suite.		* It's highly recommended to gain more knowledge about all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] are providing you for developing OX App Suite.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* Get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].		* Get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].

John.broomfield: /* Packaging */

2013-11-14T17:36:46Z

Packaging

← Older revision		Revision as of 17:36, 14 November 2013
Line 85:		Line 85:
	== Packaging ==		== Packaging ==

	When your app is ~~done,~~ you probably want to test it on a staging system, and later install it on a production system. To keep track of which installed files belong to which version of which app, you should use the native package manager of the Linux distribution of the target system. The packages can be easily created using the build system.		When your app is finished you will probably want to test it on a staging system, and later install it on a production system. To keep track of which installed files belong to which version of which app, you should use the native package manager of the Linux distribution of the target system. The packages can be easily created using the build system.

	=== Initialization ===		=== Initialization ===
Line 106:		Line 106:
	Short description: Example app		Short description: Example app

	The task presents a number of interactive prompts to get the necessary information about the generated packages. The default values are presented in square brackets ([...]) and can be selected by just pressing Enter. Otherwise, the entered values should follow the Debian ~~Maintainer's~~ Guide. Debian tools are especially picky about the syntax of the maintainer name and email address.		The task presents a number of interactive prompts to get the necessary information about the generated packages. The default values are presented in square brackets ([...]) and can be selected by just pressing Enter. Otherwise, the entered values should follow the Debian Maintainers Guide. Debian tools are especially picky about the syntax of the maintainer name and email address.

	If none of the known licenses suit you, you can enter any other license name. Then you will be asked to enter the file name of your license text. It should be a plain text file using the UTF-8 encoding.		If none of the known licenses suit you, you can enter any other license name. Then you will be asked to enter the file name of your license text. It should be a plain text file using the UTF-8 encoding.
Line 115:		Line 115:

	=== Static Files ===		=== Static Files ===
	If your app includes images (~~e.g.~~ themes do ~~this~~ most of the time), then you should check the generated packaging files for sections marked		If your app includes images (themes do most of the time), then you should check the generated packaging files for sections marked

	## Uncomment for multiple packages		## Uncomment for multiple packages
Line 123:		Line 123:

	=== Building Packages ===		=== Building Packages ===
	Since the actual package format depends on the distribution it is built for, and there already ~~exist~~ tools to create packages from suitably arranged source code archives, the OX App Suite build system merely prepares such source archives. Using the <tt>dist</tt> task to create the archives:		Since the actual package format depends on the distribution it is built for, and there are already tools available to create packages from suitably arranged source code archives, the OX App Suite build system merely prepares such source archives. Using the <tt>dist</tt> task to create the archives:

	$ build-appsuite dist		$ build-appsuite dist

← Older revision		Revision as of 17:42, 14 November 2013
Line 165:		Line 165:
	* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.		* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* You can read this to get a better overview [[AppSuite:Developing for the UI \| developing the user inferface]].		* You can read this to get a better overview of [[AppSuite:Developing for the UI \| developing the user inferface]].

← Older revision		Revision as of 17:42, 14 November 2013
Line 165:		Line 165:
	* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.		* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* To get a better overview ~~about~~ [[AppSuite:Developing for the UI \| developing the user inferface]].		* You can read this to get a better overview [[AppSuite:Developing for the UI \| developing the user inferface]].

← Older revision		Revision as of 17:41, 14 November 2013
Line 162:		Line 162:

	== Further Reading ==		== Further Reading ==
	* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] for developing for OX App Suite.		* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there are [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] for developing for OX App Suite.
	* It's highly recommended ~~to gain more knowledge about~~ all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] ~~are providing~~ you for ~~developing~~ OX App Suite.		* It's highly recommended that you read and understand all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] provide you for OX App Suite development.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* ~~Get~~ a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].		* To get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].

← Older revision		Revision as of 17:39, 14 November 2013
Line 162:		Line 162:

	== Further Reading ==		== Further Reading ==
	* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] ~~how you can develop~~ for OX App Suite.		* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] for developing for OX App Suite.
	* It's highly recommended to gain more knowledge about all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] are providing you for developing OX App Suite.		* It's highly recommended to gain more knowledge about all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] are providing you for developing OX App Suite.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* Get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].		* Get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].

← Older revision		Revision as of 17:38, 14 November 2013
Line 162:		Line 162:

	== Further Reading ==		== Further Reading ==
	* ~~You~~ just ~~build~~ your first app for OX App Suite, keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] how you can develop for OX App Suite.		* Congratulations you have just built your first app for OX App Suite, but please keep in mind that there [[AppSuite:Developing for the UI#What_can_i_build.3F \| quite a few options]] how you can develop for OX App Suite.
	* It's highly recommended to gain more knowledge about all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] are providing you for developing OX App Suite.		* It's highly recommended to gain more knowledge about all the benefits [[AppSuite:UI_build_system \| the UI build system]] and [[AppSuite:Appserver\|the Appserver]] are providing you for developing OX App Suite.
	* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.		* If you're stuck somewhere, the article about [[AppSuite:Debugging_the_UI \| debugging the UI]] might help you.
	* Get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].		* Get a better overview about [[AppSuite:Developing for the UI \| developing the user inferface]].