https://github.com/isaaceindhoven/testcafe-scaffolding
TestCafe scaffolding tool to setup your repository for end-to-end testing with TestCafe
https://github.com/isaaceindhoven/testcafe-scaffolding
scaffolding testcafe testcafe-scaffolding
Last synced: 5 months ago
JSON representation
TestCafe scaffolding tool to setup your repository for end-to-end testing with TestCafe
- Host: GitHub
- URL: https://github.com/isaaceindhoven/testcafe-scaffolding
- Owner: isaaceindhoven
- License: mit
- Created: 2020-09-22T17:55:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T12:59:14.000Z (over 3 years ago)
- Last Synced: 2025-09-17T15:56:40.076Z (9 months ago)
- Topics: scaffolding, testcafe, testcafe-scaffolding
- Language: JavaScript
- Homepage:
- Size: 184 KB
- Stars: 8
- Watchers: 10
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TestCafé scaffolding tool
This project aims to simplify and standardize the installation and configuration of automated browser tests using TestCafé for various projects. This will hopefully lower the threshold to start with browser testing in projects.
## Installation
_Note: these installation instructions assume you already have a `package.json` present in the root of your project. If you do not have this, run `npm init` or `yarn init` and follow the instructions on screen._
1. Next, run the initialization script `npx @isaac.frontend/testcafe-scaffolding` follow the on-screen instructions. This will install the proper dependencies and setup a directory structure in your project.
2. To run your test suite locally, run: `npm run test:e2e` or `yarn test:e2e`
The latest version of the following dependencies will be installed, depending on the features you want:
- [testcafe](https://www.npmjs.com/package/testcafe)
- [testcafe-browser-provider-browserstack](https://www.npmjs.com/package/testcafe-browser-provider-browserstack)
- [testcafe-reporter-allure](https://www.npmjs.com/package/@isaac.frontend/testcafe-reporter-allure)
Also, we'll install a `runner.js` in `tests/e2e` where we call the [TestCafé programmatic runner](https://devexpress.github.io/testcafe/documentation/using-testcafe/programming-interface/runner.html).
## Table of Contents
* [Writing the test suite](docs/writing-the-testsuite.md)
* [Directory structure](docs/writing-the-testsuite.md#directory-structure)
* [Architecture](docs/writing-the-testsuite.md#architecture)
* [Used language](docs/writing-the-testsuite.md#used-language)
* [Semantics](docs/writing-the-testsuite.md#semantics)
* [Utilities](docs/writing-the-testsuite.md#utilities)
* [Browser Utility](docs/utilities/browser.md)
* [Running the test suite](docs/running-the-testsuite.md)
* [Running locally](docs/running-the-testsuite.md#running-locally)
* [Running on BrowserStack](docs/running-the-testsuite.md#running-on-browserstack)
* [Allure integration](docs/allure.md)
* [Common issues](docs/common-issues.md)
## License
[MIT](https://github.com/isaaceindhoven/testcafe-scaffolding/blob/master/LICENSE) © ISAAC E-commerce Solutions BV