{"id":13981055,"url":"https://github.com/me-io/appium-selenium-starter","last_synced_at":"2025-04-07T18:32:13.060Z","repository":{"id":62526334,"uuid":"110371736","full_name":"me-io/appium-selenium-starter","owner":"me-io","description":"Open source, complete and easy to use QA Automation platform","archived":false,"fork":false,"pushed_at":"2019-01-01T11:05:58.000Z","size":2785,"stargazers_count":31,"open_issues_count":1,"forks_count":5,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-04-15T17:25:00.341Z","etag":null,"topics":["appium","automation","automation-test","codeception","qa-automation-test","selenium"],"latest_commit_sha":null,"homepage":"https://me.io","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/me-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-11T18:58:34.000Z","updated_at":"2023-08-07T12:18:06.000Z","dependencies_parsed_at":"2022-11-02T11:01:27.355Z","dependency_job_id":null,"html_url":"https://github.com/me-io/appium-selenium-starter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/me-io%2Fappium-selenium-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/me-io%2Fappium-selenium-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/me-io%2Fappium-selenium-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/me-io%2Fappium-selenium-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/me-io","download_url":"https://codeload.github.com/me-io/appium-selenium-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247707353,"owners_count":20982768,"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":["appium","automation","automation-test","codeception","qa-automation-test","selenium"],"created_at":"2024-08-09T04:01:55.240Z","updated_at":"2025-04-07T18:32:12.624Z","avatar_url":"https://github.com/me-io.png","language":"PHP","funding_links":["https://www.paypal.me/meabed"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  Appium Selenium Starter \n\u003c/h1\u003e\n\u003cp align=\"center\" style=\"font-size: 1.2rem;\"\u003eSimple and easy to use boilerplate for writing tests for mobile or web.\u003c/p\u003e\n\n\u003chr /\u003e\n\n[![Build Status][build-badge]][build]\n[![downloads][downloads-badge]][downloads]\n[![MIT License][license-badge]][license]\n[![Donate][donate-badge]][donate]\n\n[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)\n[![PRs Welcome][prs-badge]][prs] \n[![Code of Conduct][coc-badge]][coc]\n[![Watch on GitHub][github-watch-badge]][github-watch]\n[![Star on GitHub][github-star-badge]][github-star]\n[![Tweet][twitter-badge]][twitter]\n\n## Requirements\n\n1. PHP \u003e= 7.0\n2. Appium - For Mobile Testing\n3. Selenium - For Web application testing\n\n## Installation\n\nYou can install this `appium-selenium-starter` using the following methods:\n\n### Cloning the repo\n\nRun the following command to configure the boilerplate on your machine:\n\n```bash\ngit clone git@github.com:me-io/appium-selenium-starter.git\n```\n\n### Via composer create-project\n\nAlternatively, you may also install `appium-selenium-starter` by issuing the Composer create-project command in your \nterminal:\n\n```bash\ncomposer create-project --prefer-dist me-io/appium-selenium-starter\n```\n\n## Installing Dependencies\n\nNow run the following command to install required dependencies:\n\n```bash\ncomposer install\n```\n\n## Configuring Environment\n\nThere are two cli applications included in starter. To view a list of all commands in these cli applications inside your terminal run the following commands one by one:\n\n```bash\ncomposer run appium\ncomposer run selenium\n```\n\n### Appium\n\nLets configure your environment for running mobile application testing. Open your terminal and run the following command:\n\n```bash\ncomposer run appium configure\n```\n\n### Selenium\n\nTo configure your environment for running selenium server run the below command:\n\n```bash\ncomposer run selenium configure\n```\n\n## Running Example Tests\n\n\u003e **Note:** For running example tests you need to have installed and configured the android emulator or iOS simulator on your machine.\n\nBefore running the mobile tests we need to start the appium server. To start appium server run the following command inside your terminal:\n\n```bash\ncomposer run appium start\n```\n\nWe need to move everything from `example` directory to the root folder of the project. Run the following command inside your terminal:\n\n```bash\nmv example/* .\n```\n\nYou can find the android and ios example tests inside `/tests` directory. We also put some example apps for android and ios inside `/tests/_data/test-apps` directory.\n\n## Android Tests\n\nFor running android emulator we are using genymotion. Follow this [guide](https://shankargarg.wordpress.com/2016/02/25/setup-genymotion-android-emulators-on-mac-os/) \nif you do not know how to install and run android emulator. You also need to install the application that you want to test inside android emulator.\n\n### Update Suite\n\nNow you need to update the `android.suite.yml` you can find this filw inside `tests` directory. And also update the `deviceName` to your android emulator device name. If you have genymotion installed you can find the device name from the devices list.\n\n![Imgur](https://i.imgur.com/znQkuLq.png)\n\n### Running Tests\n\nTo run the android tests run the following codecept command inside your terminal:\n\n```bash\n./vendor/bin/codecept -c example/codeception.yml run android --steps\n```\n\n![Android](https://i.imgur.com/PdqDRFa.gif)\n\n\u003e **Note:** Make sure appium server is running before running the android tests.\n\n## iOS Tests\n\nFirst you need to run the appium server than you need to start the iOS simulator. Use the following if you do not know how to run iOS sumulator http://www.macinstruct.com/node/494.\n\n### Update Suite\n\nNow you need to update the `ios.suite.yml` you can find this file inside `tests` directory. Open `ios.suite.yml` file and update `xcodeOrgId` and `udid` to your running simulator `identifier` string. You can find your `identifier` string by opening the simulator then `Hardware \u003e Device \u003e Manage Devices \u003e Simulators`. You will find a list of iOS devices now open the device that you are running and after clicking on the device name you will find the `identifier` string.\n\n![](https://dr5mo5s7lqrtc.cloudfront.net/items/052N1f2U0R3r161C2A32/%5B78ae106f1ef8f1f71bcdefd4dbc5e221%5D_Image+2018-02-14+at+6.18.02+PM.png?X-CloudApp-Visitor-Id=2960388\u0026v=029ae989)\n\n### Running Tests\n\nTo run the ios tests run the following codecept command inside your terminal:\n\n```bash\n./vendor/bin/codecept -c example/codeception.yml run ios --steps\n```\n\n![iOS](https://i.imgur.com/Au45fXv.gif)\n\n## Contributors\n\nA huge thanks to all of our contributors:\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore --\u003e\n| [\u003cimg src=\"https://avatars0.githubusercontent.com/u/45731?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMohamed Meabed\u003c/b\u003e\u003c/sub\u003e](https://github.com/Meabed)\u003cbr /\u003e[💻](https://github.com/me-io/appium-selenium-starter/commits?author=Meabed \"Code\") [📢](#talk-Meabed \"Talks\") | [\u003cimg src=\"https://avatars2.githubusercontent.com/u/16267321?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eZeeshan Ahmad\u003c/b\u003e\u003c/sub\u003e](https://github.com/ziishaned)\u003cbr /\u003e[💻](https://github.com/me-io/appium-selenium-starter/commits?author=ziishaned \"Code\") [🐛](https://github.com/me-io/appium-selenium-starter/issues?q=author%3Aziishaned \"Bug reports\") [⚠️](https://github.com/me-io/appium-selenium-starter/commits?author=ziishaned \"Tests\") [📖](https://github.com/me-io/appium-selenium-starter/commits?author=ziishaned \"Documentation\") |\n| :---: | :---: |\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n## License\n\nThe code is available under the [MIT license](LICENSE.md).\n\n[build-badge]: https://img.shields.io/travis/me-io/appium-driver-codeception.svg?style=flat-square\n[build]: https://travis-ci.org/me-io/appium-driver-codeception\n[downloads-badge]: https://img.shields.io/packagist/dm/me-io/appium-selenium-starter.svg?style=flat-square\n[downloads]: https://packagist.org/packages/me-io/appium-selenium-starter/stats\n[license-badge]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\n[license]: https://github.com/me-io/appium-selenium-starter/blob/master/LICENSE.md\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: http://makeapullrequest.com\n[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square\n[coc]: https://github.com/me-io/appium-selenium-starter/blob/master/CODE_OF_CONDUCT.md\n[github-watch-badge]: https://img.shields.io/github/watchers/me-io/appium-selenium-starter.svg?style=social\n[github-watch]: https://github.com/me-io/appium-selenium-starter/watchers\n[github-star-badge]: https://img.shields.io/github/stars/me-io/appium-selenium-starter.svg?style=social\n[github-star]: https://github.com/me-io/appium-selenium-starter/stargazers\n[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20appium-selenium-starter!%20https://github.com/me-io/appium-selenium-starter%20%F0%9F%91%8D\n[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/me-io/appium-selenium-starter.svg?style=social\n[donate-badge]: https://img.shields.io/badge/paypal-donate-179BD7.svg?style=flat-squares \n[donate]: https://www.paypal.me/meabed\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fme-io%2Fappium-selenium-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fme-io%2Fappium-selenium-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fme-io%2Fappium-selenium-starter/lists"}