Skip to main content

Installation

Prerequisites​

info
  • NodeJS v16+

Create a new Cypress project​

We're going to create a new project by entering the following command into the CLI(Command Line), and we're naming our project my-cypress-app

$ npx @optimumqa/cypress-boilerplate my-cypress-app

Install dependencies​

Now we're going to enter our project and install the dependencies

$ cd my-cypress-app
$ npm install
info

Cypress boilerplate uses Cypress version 12.14.0

.gitignore​

For some reason .gitignore is not added automatically. Until we solve this issue, please add it manually:

./gitignore
# Project specific
node_modules
mochareports/
cypress/videos/
cypress/screenshots/
cypress/reports/
cypress/downloads/
cypress.local*.ts
users.local*.json

# Allure
allure-results/
allure-report/

# OS specific
.DS_Store

# Local env files
.env.local
.env.*.local

# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Editor directories and files
.idea
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw*
*.sublime-*

/tests/coverage/
/tests/e2e/reports/

You are all set! Next we are going to add a project to work with.