Files
cypress/packages/example/README.md
Zach Panzarino da3e49bf59 feat: updated scaffolding, new project & user banners, ability to remove scaffolding (#15826)
* update example build scripts

* remove old scaffolding relics

* update

* Fix some issues with scaffolding

* Correctly fix issues with scaffolding

* Replace old onboarding with new banner

* Add ability to remove scaffolded files

* Add banner for new users

* Update tests for new scaffolding

* Compare file sizes before removing

* Add tests for remove file

* Save when user opened cypress rather than boolean

* Update intro link and add tets for banners

* fix small issue

* Update design and copy of onboarding banners

* Update style of new spec file button

* Improve outline button active statE

* Update design of new project a bit more

* Fix specs list tests

* Update banner copy and layout

* Update banner copy and layout

* Switch to docs style alerts

* Fix testing logic

* Update banner styles a bit

* Update banners

* Add confirmation modal for delete specs

* Update tests and fix states

* Upgrade kitchensink dep

* Upgrade kitchen sink version and fix unit tests

* Update integration scaffolding test

* Add further description to warning modal

* Update test for new user and new project case

* Remove check to file tree when removing files

* Update kitchensink version

* Fix edge case where banner could appear when no files have been scaffolded

* Fix tests

* Update styling for 'note' when deleting files

* fix issue with path on windows

* Change remove command

* Fix rm dir

* Fix for windows

* Try to use appveyor to test

* appveyor please

* getting some feedback

* Why doesn't this work

* more info

* I have a feeling this works

* maybe its the other path

* please

* this is the one

* this is it

* this should work

* try reverting that change that might not be needed

* remove appveyor testing scaffolding

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
2021-06-22 10:59:47 -05:00

2.1 KiB

Scaffold config files

The cypress/plugins/index.js, cypress/support/* and cypress/tsconfig.json from this package are used for user scaffolding in packages/server and npm/create-cypress-tests. This configuration files are by default injected when user instals Cypress.

Examples

This repo contains the source code for pushing out https://example.cypress.io.

The actual example repo you're probably looking for is the kitchen sink app here.

THERE'S LIKELY NO REASON YOU NEED TO EDIT ANY OF THE CODE ON THIS REPO.

Updating the example app

After releasing a new version on the cypress-example-kitchen-sink repo, you now want to update the example's dependency to match the newly released version.

  1. Bump the cypress-example-kitchensink devDependency within this package's package.json.

  2. Run yarn and yarn workspace @packages/example to build the app and spec files. CONTRIBUTING

  3. Create a new pull-request following this repo's pull request instructions.

Building

After running yarn you must build the app + spec files.

yarn workspace @packages/example build

This copies the src files from cypress-example-kitchensink, modifies them to point to https://example.cypress.io and creates the example tests.

Deploying

yarn workspace @packages/example deploy