documentation for @agoric/synpress #1103
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rabi-siddique
changed the title
Deploying documentation with
|
| Latest commit: |
975de7c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://faba3a90.documentation-7tp.pages.dev |
| Branch Preview URL: | https://rs-agoric-synpress-doc.documentation-7tp.pages.dev |
|
Cloudflare deployment logs are available here |
toliaqat
reviewed
May 22, 2024
main/testing/end-to-end.md
Outdated
|
|
||
| ## Overview | ||
|
|
||
| [`@agoric/synpress`](https://github.com/agoric-labs/synpress) is an end-to-end (e2e) testing framework specifically designed for Decentralized Applications (DApps). Built on [Cypress.io](https://www.cypress.io/), it provides a fully-featured testing environment. Using `@agoric/synpress`, developers can automate and test interactions with the Keplr wallet. |
There was a problem hiding this comment.
Replace @agoric/synpress with Synpress to start the sentence with a capitalized word.
There was a problem hiding this comment.
should we differentiate our project from the actual Synpress project? to avoid any branding confusion
toliaqat
reviewed
May 22, 2024
toliaqat
reviewed
May 24, 2024
There was a problem hiding this comment.
Left a few suggestions. @frazarshad @rabi-siddique, Please have a look
main/testing/end-to-end-testing.md
Outdated
|
|
||
| [`@agoric/synpress`](https://github.com/agoric-labs/synpress) is an end-to-end (e2e) testing framework specifically designed for DApps. Built on [Cypress.io](https://www.cypress.io/), it provides a fully-featured testing environment. Using `@agoric/synpress`, developers can automate and test interactions with the Keplr wallet. | ||
|
|
||
| `@agoric/synpress` is a fork of the [`synthetixio/synpress`](https://github.com/Synthetixio/synpress) framework, which is a e2e testing framework written for the Metamask wallet. `@agoric/synpress` heavily modifies it in order to provide a robust testing framework for the Keplr wallet and Cosmos SDK. |
There was a problem hiding this comment.
Suggested change
| `@agoric/synpress` is a fork of the [`synthetixio/synpress`](https://github.com/Synthetixio/synpress) framework, which is a e2e testing framework written for the Metamask wallet. `@agoric/synpress` heavily modifies it in order to provide a robust testing framework for the Keplr wallet and Cosmos SDK. | |
| ### Background | |
| `@agoric/synpress` is a modified fork of [`synthetixio/synpress`], which was originally designed for the Metamask wallet. These modifications make it a robust framework tailored for the Keplr wallet and Cosmos SDK. |
main/testing/end-to-end-testing.md
Outdated
| ## Getting Started | ||
|
|
||
| ### Installation: | ||
| `@agoric/synpress` can be installed as a dev dependancy to any node project using the following command |
There was a problem hiding this comment.
No need to add multiple commands. One is enough and developers can find their relevant commands themselves.
Suggested change
| `@agoric/synpress` can be installed as a dev dependancy to any node project using the following command | |
| `@agoric/synpress` can be installed using the following command. |
main/testing/end-to-end-testing.md
Outdated
|
|
||
| ``` | ||
|
|
||
| 3. You're done! you can now trigger the tests by running: |
There was a problem hiding this comment.
Suggested change
| 3. You're done! you can now trigger the tests by running: | |
| 3. You can now trigger the tests by running this command: |
main/testing/end-to-end-testing.md
Outdated
Comment on lines
77
to
82
| Optionally, you can create a custom config file for your synpress setup. Since `@agoric/synpress` is based on Cypress, it follows the same config file format. | ||
| `@agoric/synpress` aleardy has some | ||
| configurations set up in this | ||
| [file](https://github.com/agoric-labs/synpress/blob/master/synpress.config.js). | ||
| To override this and add your custom config, you can create your own config | ||
| file `synpress.config.js` in `/project_dir/tests/e2e` |
There was a problem hiding this comment.
Suggested change
| Optionally, you can create a custom config file for your synpress setup. Since `@agoric/synpress` is based on Cypress, it follows the same config file format. | |
| `@agoric/synpress` aleardy has some | |
| configurations set up in this | |
| [file](https://github.com/agoric-labs/synpress/blob/master/synpress.config.js). | |
| To override this and add your custom config, you can create your own config | |
| file `synpress.config.js` in `/project_dir/tests/e2e` | |
| You can optionally create a custom configuration file for your Synpress setup. Since `@agoric/synpress` is based on Cypress, it follows the same configuration [file](https://github.com/agoric-labs/synpress/blob/master/synpress.config.js) format. To override the default settings and add your custom configurations, create a file named synpress.config.js in /project_dir/tests/e2e with the following content: |
main/testing/end-to-end-testing.md
Outdated
| }); | ||
| ``` | ||
|
|
||
| use this config by passing the `--configFile` flag to synpress |
There was a problem hiding this comment.
Suggested change
| use this config by passing the `--configFile` flag to synpress | |
| Use this configuration by passing the `--configFile` flag to Synpress. |
main/testing/end-to-end-testing.md
Outdated
|
|
||
| ### Projects Using `@agoric/synpress` | ||
|
|
||
| Here are some examples of projects utilizing `@agoric/synpress` for their e2e tests, showcasing the framework in action and demonstrating its capabilities: |
There was a problem hiding this comment.
Suggested change
| Here are some examples of projects utilizing `@agoric/synpress` for their e2e tests, showcasing the framework in action and demonstrating its capabilities: | |
| Here are some examples of projects utilizing `@agoric/synpress` for their e2e tests. These examples showcase the framework in action and demonstrate its capabilities: |
rabi-siddique
force-pushed
the
rs-agoric-synpress-doc
branch
10 times, most recently
from
9d8a82c to
c964f05
Compare
toliaqat
approved these changes
Jun 4, 2024
rabi-siddique
force-pushed
the
rs-agoric-synpress-doc
branch
3 times, most recently
from
641dad8 to
3de8926
Compare
rabi-siddique
force-pushed
the
rs-agoric-synpress-doc
branch
from
3de8926 to
147b845
Compare
rabi-siddique
force-pushed
the
rs-agoric-synpress-doc
branch
from
147b845 to
975de7c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documenting the agoric/synpress testing framework