Home - spryker-projects/cypress-boilerplate GitHub Wiki
Welcome to the Cypress Boilerplate wiki! This documentation provides a comprehensive guide to setting up and using the Cypress framework for end-to-end testing in your projects.
This wiki is structured to guide you through various aspects of the Cypress-Boilerplate project, from setting up the environment to writing and running tests. Below is a brief overview of each section:
What is E2E Testing?
An introduction to End-to-End (E2E) testing, explaining how it works, its benefits, and common use cases.
Identifying What to Test
Guidance on identifying the most important aspects of your application to cover with end-to-end tests, and what to avoid.
Project Structure
Understand the layout of the project and the purpose of each directory and file.
Getting Started
Step-by-step instructions to set up the Cypress-Boilerplate project on your local machine.
Best Practices
Recommended practices for writing effective and maintainable Cypress tests.
Naming Conventions
Guidelines for naming files, folders, and other project elements to maintain consistency and clarity.
Configuration & Environment Variables
Detailed explanation of how to configure the Cypress environment and manage environment variables.
Plugins and Libraries
An overview of the plugins and libraries used in the project, along with their purposes and usage.
ESLint and Prettier
Guidance on setting up and using ESLint and Prettier to ensure code quality and consistency.
HTML Reporter
How to set up and configure the cypress-mochawesome-reporter for generating HTML reports of your test results.
Cypress Commands vs Scenarios
A comparison between using Cypress commands and writing test scenarios, with examples and best practices.
How to validate API response vs schema
Instructions on How to add the schemas validation to tests
Debugging Cypress Tests
How to debug, pause and step through test execution, how to see the inputs and outputs of the test steps in detail.
Integrating Cypress Tests into CI
Instructions on how to integrate Cypress tests into a Continuous Integration (CI) pipeline.
Integrating Cypress‐Boilerplate into Spryker Docker/SDK
Step-by-step instructions on how to integrate Cypress-Boilerplate into your project using Docker/SDK.
We hope this documentation helps you effectively use the Cypress-Boilerplate project. Happy testing!