Skip to content

Update Readme.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 15, 2020
Merged

Update Readme.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 10 additions & 18 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Create CodeceptJS 🚀

Create CodeceptJS project easily, having all dependencies installed with one command.
One command to create a fresh CodeceptJS project or add CodeceptJS to an existing project.

```
____ ____ _____ ____ _____ _____ ____ ____ ____ _____ ____ _____ ____ _____ _ ____
Expand All @@ -11,49 +11,41 @@ Create CodeceptJS project easily, having all dependencies installed with one com

```


This script will install all required depdnedncies for CodeceptJS project.
It is not required to use `create-codeceptjs` on any project, you can install them on your own, but it is very easy to start from scratch.

![](https://user-images.githubusercontent.com/220264/87477444-c986b580-c630-11ea-9af4-f383e02dfa2d.gif)

This script will also update `scripts` section of `package.json` so you could execute tests faster without learning Codeceptjs commands.

## Installation

No installation needed 🤗
This script will also add several commands to the `scripts` section of your `package.json`, so you can just execute tests without the need to learn custom CodeceptJS commands.

## Usage


Install CodeceptJS + Playwright into current project
To install CodeceptJS + Playwright into your current project run

```
npx create-codeceptjs
```

Install CodeceptJS into "tests" directory
To install CodeceptJS + Playwright into the "tests" directory run

```
npx create-codeceptjs tests
```

Install CodeceptJS + webdriverio:
To install CodeceptJS + WebdriverIO run

```
npx create-codeceptjs --webdriverio
```

Install CodeceptJS + webdriverio into "tests" directory
To install CodeceptJS + WebdriverIO into "tests" directory

```
npx create-codeceptjs tests --webdriverio
```

Supported options:

* `--puppeteer` - install puppeteer as default helper
* `--testcafe` - install testcafe as default helper
* `--yarn` - yes, we support yarn too!


* `--puppeteer` - installs Puppeteer as default helper
* `--webdriverio` - installs WebdriverIO as default helper
* `--testcafe` - installs TestCafe as default helper
* `--use-yarn` - yes, we support yarn too!