BetterDocs End-To-End Test Automation

An awesome README template to jumpstart your projects!
Report A Bug · Contribute

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

BetterDocs is a popular WordPress plugin with thousands of users worldwide. This project creates e2e automation scripts for BetterDocs FREE & PRO plugins.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• [![Node][Node.js]][Node-url]

• [![Playwright][Playwright.js]][Playwright-url]

(back to top)

Getting Started

Let's get started!!

Prerequisites

The project requires Node.js version 22 LTS and npm.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/ShahrearMSf/BDS_Automation.git

2. Install NPM packages

   npm install

3. Create the .env file and provide necessary details

   cp .env.example .env

4. Update/Install playwright browsers.

   npx playwright install --with-deps

5. Create storage state files.

mkdir -p playwright/.auth && cd playwright/.auth
for role in admin editor author contributor subscriber unauth; do echo "{}" > "$role.json"; done

(back to top)

Usage

To run the tests:

npx playwright test

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Begin Project
• All shortcodes
• All gutenberg blocks
• All elementor widgets
  • BetterDocs Category Grid
  • BetterDocs Category Box

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the Unlicense License. See LICENSE.txt for more information.

(back to top)

Contact

Abu Hurayra - @hurayraiit - hurayraiit@gmail.com
Muammar Shahrear - @Muammar Shahrear - shahrearmuammar@gmail.com

Project Link: https://github.com/ShahrearMSf/BDS_Automation

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• othneildrew/Best-README-Template

(back to top)