Interactors Sample App

The Interactors Sample app shows some examples of using Interactors to programatically test a web app.

This repository contains the files that are created when someone runs the command npx interactors-sample to generate their own app, as they are following along with the Quick Start.

Getting Started

You'll need to run npm install to be able to execute any of the scripts inside the bin/ directory.

Start App

npm start

This script cd's into app/ and executes start-dev.js script which will make a copy of app-pkg.json as package.json, install its dependencies, and then start the app.

The reason why we're using cd instead of --cwd app/ is because that syntax is only available when using yarn.

Modifying Sample App

When you add new dependencies to the sample app:

1. You will need to modify ./app/app-pkg.json because ./app/package.json does not get published.
2. The new dependencies must also be added to the appropriate templates in ./bin/templates/.

Run Tests

This sample app has multiple testing libraries installed so that you can see how Interactors fit into your existing test suite.

npm run test:bigtest
npm run test:jest
npm run test:cypress

Install Published App

Generate a new sample app using npx:

npx interactors-sample

You can use --yarn or -Y flags to use yarn instead:

npx interactors-sample --yarn

Build App Locally

If you're adding features to the install script, as opposed to the sample app itself, you can test out the build/install process by running:

yarn dev:build

This will save you the trouble of having to publish preview packages and will create the sample app inside ./build using your local script instead of using npx.

Publishing Interactors Sample

This is a note for the project maintainers. If you make changes to this package, please bump the package version manually.