Skip to content
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.

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

Contributing section added to the README.md #103

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#### [Homepage](https://nightwatchjs.org) • [Developer Guide](https://nightwatchjs.org/guide) • [API Reference](https://nightwatchjs.org/api) • [About](https://nightwatchjs.org/about) • [Blog](https://nightwatchjs.org/blog)

Nightwatch is an integrated testing framework powered by Node.js and using the [W3C Webdriver API](https://www.w3.org/TR/webdriver/). It is a complete testing solution developed at [BrowserStack](https://www.browserstack.com/) and which can be used for:
Nightwatch is an integrated testing framework powered by Node.js and using the [W3C Webdriver API](https://www.w3.org/TR/webdriver/). It is a complete testing solution developed at [BrowserStack](https://www.browserstack.com/) and which can be used for:

☑️ end-to-end testing of web applications and websites

Expand All @@ -33,7 +33,6 @@ npm init nightwatch@latest

or, if you want to initialize a new project:


```sh
npm init nightwatch@latest ./path/to/new/project
```
Expand All @@ -52,11 +51,11 @@ npm init nightwatch@latest -- --generate-config

#### 2. Answer a few questions about your preferred setup:

- What is your Language - Test Runner setup?
- Where do you want to run your e2e tests?
- Which browsers will you be testing on?
- Where do you plan to keep your end-to-end tests?
- What is the base_url of your project?
- What is your Language - Test Runner setup?
- Where do you want to run your e2e tests?
- Which browsers will you be testing on?
- Where do you plan to keep your end-to-end tests?
- What is the base_url of your project?
- Allow Nightwatch to anonymously collect usage metrics?
- Would you like to run your e2e tests on Mobile devices as well?

Expand All @@ -70,8 +69,32 @@ You can follow the instructions given at the end of the setup to run your first

<img width="413" alt="image" src="https://user-images.githubusercontent.com/39924567/174763723-aff4d501-6320-402c-81cc-de75fbb5e8f0.png">

## Contributing

We welcome any and all community contributions that may help us enhance Nightwatch.

### Running locally

1. First, fork the repository to your own GitHub account.
2. Clone the forked repository from your own GitHub account by running the following command in terminal:
```sh
git clone https://github.com/<USERNAME>/create-nightwatch.git
```
3. Navigate to the locally cloned repository:
```sh
cd create-nightwatch
```
4. Install all the dependencies:
```sh
npm install
```
5. Run the project locally:
```sh
npm run create-nightwatch <project-name>
```

## Licence

[MIT](https://github.com/nightwatchjs/nightwatch/blob/main/LICENSE.md)

[discord-badge]: https://img.shields.io/discord/618399631038218240.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square
Expand Down