{"id":13848990,"url":"https://github.com/phonegap/phonegap-app-developer","last_synced_at":"2025-05-14T21:06:02.936Z","repository":{"id":825867,"uuid":"8786912","full_name":"phonegap/phonegap-app-developer","owner":"phonegap","description":"PhoneGap Developer App","archived":false,"fork":false,"pushed_at":"2022-05-21T09:52:55.000Z","size":18425,"stargazers_count":1988,"open_issues_count":86,"forks_count":2488,"subscribers_count":88,"default_branch":"master","last_synced_at":"2025-04-14T12:58:28.592Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"app.phonegap.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phonegap.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-14T22:35:17.000Z","updated_at":"2025-03-20T08:21:52.000Z","dependencies_parsed_at":"2022-08-04T19:16:35.275Z","dependency_job_id":null,"html_url":"https://github.com/phonegap/phonegap-app-developer","commit_stats":null,"previous_names":[],"tags_count":84,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phonegap%2Fphonegap-app-developer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phonegap%2Fphonegap-app-developer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phonegap%2Fphonegap-app-developer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phonegap%2Fphonegap-app-developer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phonegap","download_url":"https://codeload.github.com/phonegap/phonegap-app-developer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254227611,"owners_count":22035669,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T19:01:04.550Z","updated_at":"2025-05-14T21:06:02.864Z","avatar_url":"https://github.com/phonegap.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# PhoneGap Developer App [![Build Status][travis-ci-img]][travis-ci-url]\n\n\u003e Available in an app store near you!\n\n## Overview\n\nThe PhoneGap Developer app is a testing utility for web developers and designers\nusing the PhoneGap framework. After installing the PhoneGap Developer app you\ncan connect to your PhoneGap desktop app to instantly view and test your project\non the device.\n\nFor more information, see [Developer App Reference Guide][3] on the PhoneGap Docs.\n\n## Download\n\n- [Android Google Play][1]\n- [Windows Phone store][7]\n\n## Documentation\n\n- [Developer App Reference Guide](http://docs.phonegap.com/references/developer-app/)\n- [FAQ/Troubleshooting](http://docs.phonegap.com/references/developer-app/troubleshoot-faq/)\n- [Unable to Connect or Download from Server](http://docs.phonegap.com/references/developer-app/troubleshoot-faq/#phonegap-developer-app-is-unable-to-download-from-the-server)\n\n## Development\n\n### Setup\n\nThe repository includes everything required to compile the app. You can get\nsetup by:\n\n```shellsession\n$ git clone https://github.com/phonegap/phonegap-app-developer.git\n$ cd phonegap-app-developer/\n$ npm install\n```\n\n### Compile and Run\n\nThe app bundles the `phonegap` npm module as a dependency. This means that\nthere is no need for a global installation of `phonegap` or `cordova`.\nBy editing the `package.json`, you can specify the exact version of `phonegap`\nto compile the project.\n\nSince a global install of the `phonegap` module is not required, we use\n`npm run` scripts to compile and run the application. This allows the app's\n`platforms/` and `plugins/` directories to be removed and rebuilt each time,\nensuring a consistent build using the correct PhoneGap, Cordova, platform,\nand plugin versions.\n\nThe command structure is:\n```shellsession\n$ npm run phonegap -- \u003ccommand\u003e [args]\n```\n\nFor example, you can check the version of `phonegap`:\n```shellsession\n$ npm run phonegap -- --version\n```\n\nYou can compile and run iOS or Android:\n```shellsession\n$ npm run phonegap -- run ios\n$ npm run phonegap -- run android\n```\n\nFor developers wishing to use the platform SDKs (Xcode, Eclipse, Visual Studio),\nplease build once with the CLI to correctly populate the platform assets:\n```shellsession\n$ npm run phonegap -- build \u003cplatform\u003e\n```\n\nDue to a Windows npm bug, the `--` does not work. Therefore we have created\nrun script that will build Windows Phone 8, so it can run in Visual Studio.\n```shellsession\n$ npm run phonegap-wp8\n```\n\n### Running the Tests\n\nThere are two types of test targets: the local app and served app.\n\n#### Test the Local Application\n\nThe local application is the PhoneGap Developer App. To test the local\nfunctionality, we build the application with mobile-spec. This allows us to\nensure that each plugin was correctly installed. Eventually, we would like\nto add functional tests for the app logic.\n\nYou can run the local tests with:\n```shellsession\n$ npm run phonegap -- run android --test\n$ npm run phonegap -- run ios --test\n```\n\nAgain for Windows Phone, we have a run script that will build the app so it can run in\nVisual Studio.\n```shellsession\n$ npm run phonegap-wp8-test\n```\n\n#### Test the Served Application\n\nThe served application is the app served by the CLI. To test the server\nfunctionality, we serve an instance of mobile-spec. We can then use the manual\nand automatic tests to ensure that the server provided the correct version of\nCordova, the plugins, and the navigation logic.\n\nYou can run the served tests with:\n```shellsession\n$ cd tests/\n$ phonegap serve\n# now connect with the latest build of the PG App\n```\n\n### Updating the Tests\n\nIt's as easy as a copy and paste.\n\n1. Copy all content of `cordova-mobile-spec`\n2. Paste the content into `tests/www`\n\nOn your first run of the tests, you may see some modified files. This is expected\nbecause the test runner invoked by `--test` modifies certain files to support\nour app's configuration.\n\n### Adding Custom Plugins\n\nIf you're a developer interested in creating your own custom build of the\nPhoneGap Developer App, then this section is for you!\n\nSince the PhoneGap Developer app bundles `phonegap` as a npm dependency and\ntreats the `platforms/` and `plugins/` as artifacts, you'll find that it is very\neasy to add your own plugins and alter other aspects of the app.\n\nYou may visit the [PhoneGap docs](http://docs.phonegap.com/references/developer-app/custom-build/ios/) for a more in-depth guide or follow the steps below.\n\nFirst, [Setup](#user-content-setup) the project on your local system.\n\nSecond, edit the `config.xml` to add a custom plugin, change a preference, or\nconfigure the app's name. You should also change the app's id to your own\nunique app bundle id:\n\n```xml\n\u003c?xml version='1.0' encoding='utf-8'?\u003e\n\u003cwidget id=\"org.mycompany.phonegap.app\" version=\"1.6.2\" xmlns=\"http://www.w3.org/ns/widgets\" xmlns:gap=\"http://phonegap.com/ns/1.0\"\u003e\n```\n\nThird, follow the [Compile and Run](#user-content-compile-and-run) section to\nget the app onto your device.\n\nIf you run into any problems, feel free to [submit an issue](https://github.com/phonegap/phonegap-app-developer/issues).\n\n### Releases\n\nReleases are also generated using the npm scripts:\n```shellsession\n$ npm run release-android\n$ npm run release-ios\n$ npm run release-wp\n```\n\nIn order to properly code-sign Android and iOS, you must setup the signing key.\nThis is accomplished by cloning the signing key repository and sym-linking each\nplatform directory with the PhoneGap Developer App repository:\n```shellsession\n# in your development directory\n$ git clone https://github.com/phonegap/phonegap-app-developer-keys.git\n\n$ cd path/to/phonegap-app-developer/\n$ ln -s /path/to/phonegap-app-developer-keys/keys/ios resources/signing/ios\n$ ln -s /path/to/phonegap-app-developer-keys/keys/android resources/signing/android\n```\n\n### Contributing, Commits, and Tags\n\nSee the [CONTRIBUTING.md][6] file for details.\n\n[1]: https://play.google.com/store/apps/details?id=com.adobe.phonegap.app\n[3]: http://docs.phonegap.com/references/developer-app/\n[4]: http://github.com/phonegap/connect-phonegap\n[5]: http://github.com/phonegap/phonegap-cli\n[6]: https://github.com/phonegap/phonegap-app-developer/blob/master/CONTRIBUTING.md\n[7]: http://www.windowsphone.com/en-us/store/app/phonegap-developer/5c6a2d1e-4fad-4bf8-aaf7-71380cc84fe3\n[travis-ci-img]: https://travis-ci.org/phonegap/phonegap-app-developer.svg?branch=master\n[travis-ci-url]: http://travis-ci.org/phonegap/phonegap-app-developer\n[bithound-img]: https://www.bithound.io/github/phonegap/phonegap-app-developer/badges/score.svg\n[bithound-url]: https://www.bithound.io/github/phonegap/phonegap-app-developer\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphonegap%2Fphonegap-app-developer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphonegap%2Fphonegap-app-developer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphonegap%2Fphonegap-app-developer/lists"}