{"id":29895559,"url":"https://github.com/klamping/wdio-starter-kit","last_synced_at":"2025-08-01T07:21:03.604Z","repository":{"id":142846383,"uuid":"96261569","full_name":"klamping/wdio-starter-kit","owner":"klamping","description":"Boilerplate repo for quick set up of WebdriverIO test scripts with TravisCI, Sauce Labs and Visual Regression Testing","archived":false,"fork":false,"pushed_at":"2019-03-26T03:19:48.000Z","size":60,"stargazers_count":31,"open_issues_count":0,"forks_count":22,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-06-14T21:09:04.401Z","etag":null,"topics":["automation","starter-kit-for-front-end-developer","testing","webdriverio"],"latest_commit_sha":null,"homepage":"https://learn.webdriver.io","language":"JavaScript","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/klamping.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-05T00:32:00.000Z","updated_at":"2023-03-16T19:06:26.000Z","dependencies_parsed_at":"2023-06-04T21:00:24.634Z","dependency_job_id":null,"html_url":"https://github.com/klamping/wdio-starter-kit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/klamping/wdio-starter-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klamping%2Fwdio-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klamping%2Fwdio-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klamping%2Fwdio-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klamping%2Fwdio-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klamping","download_url":"https://codeload.github.com/klamping/wdio-starter-kit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klamping%2Fwdio-starter-kit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268185548,"owners_count":24209387,"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","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["automation","starter-kit-for-front-end-developer","testing","webdriverio"],"created_at":"2025-08-01T07:20:59.612Z","updated_at":"2025-08-01T07:21:03.596Z","avatar_url":"https://github.com/klamping.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/klamping/wdio-starter-kit.svg?branch=master)](https://travis-ci.org/klamping/wdio-starter-kit)\n[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard)\n\n# WebdriverIO Starter Kit\n\nBoilerplate repo for quick set up of WebdriverIO test scripts with TravisCI, Sauce Labs and Visual Regression Testing\n\n## Configuration\n\n1. Clone the repo and run `npm install`\n2. Add a valid `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` to your environment variables to enable that integration. ([Settting up Sauce](http://webdriver.io/guide/usage/cloudservices.html#Sauce-Labs))\n3. Update the 'baseUrl' property in `wdio.conf.js` and `wdio.conf.local.js`\n4. Update the spec files and page objects in the test folder\n\n## Usage\n\nBy default, the kit is set up to run tests using the `npm test` command.\n\nYou can also lint your code with `npm run lint`.\n\n## This kit features:\n\n- [Login \u0026 Registration Tests, with Page Objects](#starter-test-cases)\n- [Mocha](http://mochajs.org/)\n- [Chai with `expect` global](http://chaijs.com/guide/styles/#expect)\n- [Chai WebdriverIO](https://github.com/marcodejongh/chai-webdriverio)\n- [Sauce Labs integration](http://webdriver.io/guide/usage/cloudservices.html#Sauce-Labs)\n- [Visual Regression Tests](https://github.com/zinserjan/wdio-visual-regression-service)\n- [Local notifications](http://blog.kevinlamping.com/continuous-local-webdriverio-testing-with-onchange-and-node-notifier-watching/)\n- [ESLint](http://eslint.org/) using [Semistandard style](https://github.com/Flet/semistandard)\n- [WebdriverIO tuned Gitignore file](https://github.com/klamping/wdio-starter-kit/blob/master/.gitignore#L61)\n\n## More Details\n\n### Starter Test Cases\n\nBecause login and registration pages are ubiquitous on websites, I've included two test files with corresponding page objects.\n\nYou'll very likely need to replace the selectors used in the page objects.\n\nYou'll also want to update the `isLoggedIn` and `isRegistered` functions in the page objects to return the proper response.\n\n### Folder Structure\n\nTests and page objects go in the `test\\` folder, which you'll need to create.\n\nName tests with a `.spec.js` extension. For example: `mytest.spec.js`\n\nName Page Object files with a `.page.js` extention.  For example: `mypageobject.page.js`\n\nVisual regression screenshots will be saved to the `screenshots` folder.\n\n### TravisCI Integration\n\nThis kit includes a basic `.travis.yml` file set up to allow easy integration with their service. Simply enable your repo in [TravisCI](https://travis-ci.org/) and you'll get it up and running. And be sure to update the badge information at the top of this file.\n\n### Debug Command Line Flag to adjust timeout\n\nBy setting the 'DEBUG' environment variable to true, the test timeout with be essentially removed, allowing you to run [the `debug` command](https://www.youtube.com/watch?v=xWwP-3B_YyE\u0026lc=z12gw1vqpu2sunjeq222hrsxstf3glohh04) without your tests timing out. \n\n`DEBUG=true npm test`\n\n### Configuration file flavors\n\nBy default, tests will run in Sauce Labs testing your production server.\n\nTo run the tests entirely locally, run:\n\n`npm test wdio.conf.local.js`\n\n## Configurations\n\n[WebdriverIO configurations](http://webdriver.io/guide/testrunner/gettingstarted.html) can be passed in via a double-dash (i.e. `--`).\n\nFor example, to run a single test file, use the WDIO `spec` flag: `npm test -- --spec=login`\n\nThe double dash indicates that the remaining options should be sent to the command that NPM is running, not NPM itself.\n\nIn the previous example everything after `--` goes to WDIO.\n\nA few more examples:\n\nTo change the log level, pass in a `--logLevel` flag: `npm test -- --logLevel=verbose`\n\nTo specify a certain web server, pass in a `baseUrl` flag: `npm test -- --baseUrl=http://url.of.server`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklamping%2Fwdio-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklamping%2Fwdio-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklamping%2Fwdio-starter-kit/lists"}