AppSuite:GettingStarted 7.6.0 - Revision history

Khgras: Replaced content with "The content on this page has moved to https://documentation.open-xchange.com/latest/ui/customize/app/first-app.html Note: Open-Xchange is in the process of migrating all..."

2017-05-22T09:22:26Z

Replaced content with "The content on this page has moved to https://documentation.open-xchange.com/latest/ui/customize/app/first-app.html Note: Open-Xchange is in the process of migrating all..."

Show changes

Frank.paczynski at 14:04, 8 February 2016

2016-02-08T14:04:11Z

← Older revision		Revision as of 14:04, 8 February 2016
Line 1:		Line 1:
			<!-- !!! -->
			<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation -->
			<!-- !!! -->

	<div class="title">Getting Started</div>		<div class="title">Getting Started</div>

Usman.ahmad at 14:47, 8 December 2015

2015-12-08T14:47:50Z

← Older revision		Revision as of 14:47, 8 December 2015
Line 144:		Line 144:
	* 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 of [[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]].

			[[Category: OX7]]
			[[Category: AppSuite]]

J.ohny.b: /* Packaging */

2014-08-22T12:17:21Z

Packaging

← Older revision		Revision as of 12:17, 22 August 2014
Line 93:		Line 93:

	Together with our ox-ui-module generator (from version 0.8.0), we provide you with generators for packaging information.		Together with our ox-ui-module generator (from version 0.8.0), we provide you with generators for packaging information.

			To enable some grunt tasks to help you, you can optionally install (with npm install) <tt>grunt-contrib-compress</tt> and <tt>grunt-exec</tt>. You will need those to run the grunt tasks described below.

	=== Generating a source tarball ===		=== Generating a source tarball ===
Line 126:		Line 128:
	''Please remember, that the generated spec file is only a scaffold for a real one. It will work for very simple cases, but as soon as your package gets more complicated, you will have to adjust it to your needs.''		''Please remember, that the generated spec file is only a scaffold for a real one. It will work for very simple cases, but as soon as your package gets more complicated, you will have to adjust it to your needs.''

	Once you have a debian/ directory for your project, you can go on.		Once you have a debian/ directory for your project, you can go on. Now you can run:
	~~To enable some grunt tasks to help you, you need to install (with npm install) <tt>grunt-contrib-compress</tt> and <tt>grunt-exec</tt>~~. Now you can run:

	$ grunt dpkg-buildpackage --include-dependencies		$ grunt dpkg-buildpackage --include-dependencies

Cutmasta: /* Testing an App */

2014-08-04T13:32:06Z

Testing an App

← Older revision		Revision as of 13:32, 4 August 2014
Line 67:		Line 67:
	$ grunt show-config:local --output grunt/local.conf.json		$ grunt show-config:local --output grunt/local.conf.json

	To use the remote www.ox.io AppSuite server, open up the file <tt>grunt/local.conf.json</tt> in your editor and add <tt><nowiki>"https://www.ox.io/appsuite/"</nowiki></tt> to the <tt>server</tt> setting of the appserver section. Also make sure that the <tt>protocol</tt> setting is set to <tt>https</tt>. Else you will get https redirect errors in your browser. If you are using a locally installed AppSuite server (in a VM or similar in your local network), just modify the server + protocol accordingly.		To use the remote www.ox.io AppSuite server, open up the file <tt>grunt/local.conf.json</tt> in your editor and add <tt><nowiki>"https://www.ox.io/appsuite/"</nowiki></tt> to the <tt>server</tt> setting of the appserver section. Also make sure that the <tt>protocol</tt> setting is set to <tt>https</tt>. Else you will get https redirect errors in your browser.

			INFO: If you are using a locally installed AppSuite server (in a VM or similar in your local network), just modify the server + protocol accordingly.

	Then start the development server:		Then start the development server:

Cutmasta: /* Testing an App */

2014-08-04T13:31:47Z

Testing an App

← Older revision		Revision as of 13:31, 4 August 2014
Line 67:		Line 67:
	$ grunt show-config:local --output grunt/local.conf.json		$ grunt show-config:local --output grunt/local.conf.json

	~~Open~~ up the file <tt>grunt/local.conf.json</tt> in your editor and add <tt><nowiki>"https://www.ox.io/appsuite/"</nowiki></tt> to the <tt>server</tt> setting of the appserver section. Also make sure that the <tt>protocol</tt> setting is set to <tt>https</tt>. Else you will get https redirect errors in your browser.		To use the remote www.ox.io AppSuite server, open up the file <tt>grunt/local.conf.json</tt> in your editor and add <tt><nowiki>"https://www.ox.io/appsuite/"</nowiki></tt> to the <tt>server</tt> setting of the appserver section. Also make sure that the <tt>protocol</tt> setting is set to <tt>https</tt>. Else you will get https redirect errors in your browser. If you are using a locally installed AppSuite server (in a VM or similar in your local network), just modify the server + protocol accordingly.

	Then start the development server:		Then start the development server:

Cutmasta: /* Development cycle */

2014-08-04T13:30:37Z

Development cycle

← Older revision		Revision as of 13:30, 4 August 2014
Line 84:		Line 84:

	Once you are sure that your setup works, you can extend the example and write the actual code for your app. The <tt>dev</tt> task will detect any changes and rebuild your app and even reload all browsers connected to		Once you are sure that your setup works, you can extend the example and write the actual code for your app. The <tt>dev</tt> task will detect any changes and rebuild your app and even reload all browsers connected to
	<tt>~~http~~://localhost:8337/appsuite</tt>.		<tt>https://localhost:8337/appsuite</tt>.

	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 [[AppSuite:Debugging_the_UI \| article about debugging the user interface]] which helps you avoid and fix typical errors.

Cutmasta: /* Testing an App */

2014-08-04T13:30:28Z

Testing an App

← Older revision		Revision as of 13:30, 4 August 2014
Line 77:		Line 77:
	Once appserver is running, you can access OX App Suite by opening your browser using this address:		Once appserver is running, you can access OX App Suite by opening your browser using this address:

	~~http~~://localhost:8337/appsuite		https://localhost:8337/appsuite

	After logging in, the app should be loaded and display the <tt>alert</tt> message.		After logging in, the app should be loaded and display the <tt>alert</tt> message.

Cutmasta: /* Testing an App */

2014-08-04T13:30:11Z

Testing an App

← Older revision		Revision as of 13:30, 4 August 2014
Line 61:		Line 61:
	== Testing an App ==		== Testing an App ==

	The freshly built code can now be tested. Instead of uploading your code to an OX App Suite server, you can use the [[AppSuite:Appserver\|appserver]] proxy to inject your code into the UI code of any existing OX App Suite installation. For example, to start <tt>appserver</tt> using [https://www.ox.io/ ox.io] as the server, you will need a local configuration pointing to that server. You can generate it with this command:		The freshly built code can now be tested. Instead of uploading your code to an OX App Suite server, you can use the [[AppSuite:Appserver\|appserver]] proxy to inject your code into the UI code of any existing OX App Suite installation. For example, to start <tt>appserver</tt> using [https://www.ox.io/ www.ox.io] as the server, you will need a local configuration pointing to that server. You can register for a free user account on [https://www.ox.io/ www.ox.io].

			You can generate it with this command:

	$ grunt show-config:local --output grunt/local.conf.json		$ grunt show-config:local --output grunt/local.conf.json

	Open up the file <tt>grunt/local.conf.json</tt> in your editor and add <tt><nowiki>"https://www.ox.io/appsuite/"</nowiki></tt> to the <tt>server</tt> setting of the appserver section. Then start the development server:		Open up the file <tt>grunt/local.conf.json</tt> in your editor and add <tt><nowiki>"https://www.ox.io/appsuite/"</nowiki></tt> to the <tt>server</tt> setting of the appserver section. Also make sure that the <tt>protocol</tt> setting is set to <tt>https</tt>. Else you will get https redirect errors in your browser.

			Then start the development server:

	$ grunt dev		$ grunt dev

Cutmasta: /* Testing an App */

2014-08-04T13:27:25Z

Testing an App

← Older revision		Revision as of 13:27, 4 August 2014
Line 61:		Line 61:
	== Testing an App ==		== Testing an App ==

	The freshly built code can now be tested. Instead of uploading your code to an OX App Suite server, you can use the [[AppSuite:Appserver\|appserver]] proxy to inject your code into the UI code of any existing OX App Suite installation. For example, to start <tt>appserver</tt> using [~~http~~://ox.io/ ox.io] as the server, you will need a local configuration pointing to that server. You can generate it with this command:		The freshly built code can now be tested. Instead of uploading your code to an OX App Suite server, you can use the [[AppSuite:Appserver\|appserver]] proxy to inject your code into the UI code of any existing OX App Suite installation. For example, to start <tt>appserver</tt> using [https://www.ox.io/ ox.io] as the server, you will need a local configuration pointing to that server. You can generate it with this command:

	$ grunt show-config:local --output grunt/local.conf.json		$ grunt show-config:local --output grunt/local.conf.json

	Open up the file <tt>grunt/local.conf.json</tt> in your editor and add <tt><nowiki>"https://ox.io/appsuite/"</nowiki></tt> to the <tt>server</tt> setting of the appserver section. Then start the development server:		Open up the file <tt>grunt/local.conf.json</tt> in your editor and add <tt><nowiki>"https://www.ox.io/appsuite/"</nowiki></tt> to the <tt>server</tt> setting of the appserver section. Then start the development server:

	$ grunt dev		$ grunt dev