- What Do I Upload?
- How Do I Configure My Application?
- How Do I Structure My Application?
- Where can I Get Help?
Preparing the Assets
PhoneGap and PhoneGap Build use an open packaging model that follows the W3C Widget Packaging specification. This consists of a
config.xml file, and your web assets (html, js, css, images, etc). You should not be uploading native application code files (.c, .h, .m, java, etc). See the PhoneGap Hello World Application for a basic example. This application is also explained in more detail here.
Don't include phonegap.js or plugin files
PhoneGap Build will inject
cordova.js (identical sources), and any files required by your plugins. This is because these files differ depending on the versions of PhoneGap and any plugins you are using.
For maximum sizes of zip uploads, see the plans page.
You'll need an application configuration file, or
config.xml, in your app package to configure how your app is built. This includes PhoneGap version, icons and splash screens, platforms, and much more. See the configuration section for more on the config.xml file.
PhoneGap Build's only requirement for your application structure is that the
index.html is in the top level of your application. Other than that
you can structure your application as dictated by your workflows.
As your application may contain files or directories not required in your application (unused splash screens, bower packages, grunt artifacts, un-compiled less files etc.) we support a
special file called
.pgbomit is a file that you can create and add to a directory that signifies to PhoneGap Build that it SHOULD NOT
include the contents of that directory as source for the native application. This folder, however, can be
used to store any files needed during the PhoneGap Build process up to the compile step.
A typical use case is for a directory containing the icons and splashcreens for an app. Place
.pgbomit in that directory and none of those files/directories will be included in the binary app package, except those copied and used for icons and splashscreens for a specific platform.
Please note that the
.pgbomit file is a placeholder file only, it is not read and its only function is to highlight a directory. It is not like .gitignore or other file types that can contain patterns.
Please search all communication channels prior to posting questions to help us reduce repetition and keep the forums useful and efficient! Here's some channels:
- Search our old community forum
- For help on developing your application (plugins, APIs, platform quirks, etc), see the Adobe PhoneGap Forum
- For help specifically using the PhoneGap Build Service (website, API, build errors), post to the Adobe PhoneGap Build Forum