mirror of
https://github.com/cypress-io/cypress.git
synced 2026-01-30 11:00:35 -06:00
47faf52e16
* use yarn workspace over lerna for individual package commands * remove usage of wait-on * fix readmes after regex replace * revert wait-on changes * update yarn.lock
37 lines
1.8 KiB
Markdown
37 lines
1.8 KiB
Markdown
## Example
|
|
|
|
This repo contains the source code for pushing out [https://example.cypress.io](https://example.cypress.io).
|
|
|
|
The actual example repo you're probably looking for is [the kitchen sink app here](https://github.com/cypress-io/cypress-example-kitchensink).
|
|
|
|
**THERE'S LIKELY NO REASON YOU NEED TO EDIT ANY OF THE CODE ON THIS REPO.**
|
|
|
|
- Want to edit the `example` tests? -> edit it [here](https://github.com/cypress-io/cypress-example-kitchensink/blob/master/cypress/integration/examples) instead.
|
|
- Want to edit the actual [https://example.cypress.io](https://example.cypress.io) website? edit it [here](https://github.com/cypress-io/cypress-example-kitchensink/tree/master/app) instead.
|
|
|
|
## Updating the `example` app
|
|
|
|
After [releasing a new version](https://github.com/cypress-io/cypress-example-kitchensink/blob/master/CONTRIBUTING.md#deployment) on the [`cypress-example-kitchen-sink` repo](https://github.com/cypress-io/cypress-example-kitchensink/blob/master/cypress/integration/examples), 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`](https://github.com/cypress-io/cypress/blob/develop/packages/example/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](CONTRIBUTING.md#pull-requests).
|
|
|
|
## Building
|
|
|
|
After running `yarn` you must build the app + spec files.
|
|
|
|
```bash
|
|
yarn workspace @packages/example build
|
|
```
|
|
|
|
This copies the src files from [`cypress-example-kitchensink`](https://github.com/cypress-io/cypress-example-kitchensink), modifies them to point to `https://example.cypress.io` and creates the `example` tests.
|
|
|
|
## Deploying
|
|
|
|
```bash
|
|
yarn workspace @packages/example deploy
|
|
```
|