{"id":18697455,"url":"https://github.com/frameworkium/frameworkium-examples","last_synced_at":"2025-04-12T07:32:04.614Z","repository":{"id":36406161,"uuid":"40711093","full_name":"Frameworkium/frameworkium-examples","owner":"Frameworkium","description":"Sample project which utilises frameworkium-core, a framework for writing maintainable Selenium and REST API tests and facilitates reporting and integration to JIRA.","archived":false,"fork":false,"pushed_at":"2022-12-22T12:02:24.000Z","size":836,"stargazers_count":52,"open_issues_count":7,"forks_count":37,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-26T03:01:55.475Z","etag":null,"topics":["allure","frameworkium","selenium","selenium-webdriver"],"latest_commit_sha":null,"homepage":"https://frameworkium.github.io/","language":"Java","has_issues":false,"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/Frameworkium.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}},"created_at":"2015-08-14T11:07:12.000Z","updated_at":"2024-11-10T16:03:49.000Z","dependencies_parsed_at":"2023-01-17T01:11:53.274Z","dependency_job_id":null,"html_url":"https://github.com/Frameworkium/frameworkium-examples","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frameworkium%2Fframeworkium-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frameworkium%2Fframeworkium-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frameworkium%2Fframeworkium-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frameworkium%2Fframeworkium-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Frameworkium","download_url":"https://codeload.github.com/Frameworkium/frameworkium-examples/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248534033,"owners_count":21120206,"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":["allure","frameworkium","selenium","selenium-webdriver"],"created_at":"2024-11-07T11:24:23.612Z","updated_at":"2025-04-12T07:32:04.087Z","avatar_url":"https://github.com/Frameworkium.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Frameworkium Examples \n![build](https://github.com/frameworkium/frameworkium-examples/workflows/frameworkium-examples%20build/badge.svg)\n\nThis is a *sample project* which utilises [frameworkium-core][frameworkium-core], \na framework for writing maintainable Selenium and REST API tests that also makes \nintegrating with other test things (e.g. JIRA) much easier.\n\nPlease see the [Frameworkium usage guide][guidance] for more details.\n\nAs a result:\n* Please [raise issues][core-issues] against the [frameworkium-core][frameworkium-core] project, not this one\n* See the [frameworkium-core releases page][core-releases] for information about changes and new features\n* This example project is not updated as regularly as the [core project][frameworkium-core]\n* To keep up to date with the latest releases of core, modify the following block in the `pom.xml`:\n```xml\n\u003cdependencies\u003e\n  \u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.frameworkium\u003c/groupId\u003e\n    \u003cartifactId\u003eframeworkium-core\u003c/artifactId\u003e\n    \u003c!-- Update this with the latest from the frameworkium-core releases page --\u003e\n    \u003cversion\u003e3.0.0\u003c/version\u003e\n  \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\nThe Frameworkium project is based on Ardesco's [Selenium-Maven-Template][ardesco] and \nJoe VDW's [Bootstrapium][bootstrapium]. We have extended it with some handy extras\nfor getting started quickly with Selenium, Appium and [Rest Assured][rest-assured].\n\n## Getting Started\n\nAfter setting up [apache maven][mvn], open the `frameworkium-examples` directory in a \nterminal/command prompt and run `mvn clean verify` to run the example tests using Firefox.\n\nYou will need the [geckodriver][geckodriver] on your path if you are using \nFirefox version 48 or above.\n\n### Browsers\n\nYou can provide the `-Dbrowser` argument to chose a browser to run the tests in.\n\n#### Drivers\n\nEach browser requires a \"driver\".\n\nFor chrome, [ChromeDriver][chromedriver] needs to be on your path or specified\nas an argument:\n```\nmvn clean verify -Dbrowser=chrome -Dwebdriver.chrome.driver=c:\\path\\to\\chromedriver.exe\n```\n\nFor Firefox 48 and above, [geckodriver][geckodriver] needs to be on your path or specified\nas an argument:\n```\nmvn clean verify -Dbrowser=firefox -Dwebdriver.gecko.driver=c:\\path\\to\\geckodriver.exe\n```\n\n### Selenium Grid\n\nWant to run tests using a grid and in parallel?\n```\nmvn clean verify -Dbrowser=chrome -DgridURL=http://localhost:4444/wd/hub -Dthreads=4\n```\n\nAll you need to do is ensure the browser is installed in the default location\nand that the driver is on the path.\n\n### Sauce Labs\n\nRunning mobile web tests using Appium on Sauce Labs is only slightly more involved:\n\n```bash\nexport SAUCE_USERNAME=username\nexport SAUCE_ACCESS_KEY=access_key\nmvn clean verify -Dplatform=ios -Dbrowser=safari -Dsauce=true \n```\n\n### BrowserStack\n\nRunning mobile web tests using Appium on BrowserStack:\n\n```bash\nexport BROWSER_STACK_USERNAME=username\nexport BROWSER_STACK_ACCESS_KEY=access_key\nmvn clean verify -Dplatform=ios -Dbrowser=safari -DbrowserStack=true \n```\n\nA full list of arguments can be found on the [guidance page][guidance].\n\n### Reporting\n\nAfter running your tests, you can generate an [Allure][allure] test report by \nsimply running:\n\n```\nmvn allure:report \n```\n\n## Further Information\n\nFrameworkium sets you up for other stuff too - check out the\n[guidance page][guidance] for further info.\n\n[status-svg]: https://travis-ci.org/Frameworkium/frameworkium-examples.svg?branch=master\n[status]: https://travis-ci.org/Frameworkium/frameworkium-examples\n[ardesco]: https://github.com/Ardesco/Selenium-Maven-Template\n[bootstrapium]: https://github.com/jvanderwee/bootstrapium\n[rest-assured]: http://rest-assured.io/\n[frameworkium-core]: https://github.com/Frameworkium/frameworkium-core\n[core-issues]: https://github.com/Frameworkium/frameworkium-core/issues\n[core-releases]: https://github.com/Frameworkium/frameworkium-core/releases\n[mvn]: https://maven.apache.org/download.cgi\n[geckodriver]: https://github.com/mozilla/geckodriver/releases\n[chromedriver]: https://sites.google.com/a/chromium.org/chromedriver/home\n[guidance]: https://frameworkium.github.io\n[allure]: https://docs.qameta.io/allure/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fframeworkium%2Fframeworkium-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fframeworkium%2Fframeworkium-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fframeworkium%2Fframeworkium-examples/lists"}