Eightshift Forms Plugin

Eightshift forms plugins is a complete form builder tool that utilizes modern Block editor features with multiple third-party integrations to boost your project to another level.

⚠️ Requirements

To get started, you'll need:

• Node LTS
• Composer
• Bun
• git
• WP-CLI

🏁 Quick start

Clone the project + build to get started:

1. git clone git@github.com:infinum/eightshift-forms.git
2. composer install
3. bun install
4. bun start

📚 Documentation

Eightshift forms documentation is located here.

Eightshift forms plugin is created on the Eightshift development kit.

🧪 Testing

All e2d tests are run using Playwright and are located in the tests/e2e folder and are run in isolated environment using WP Playground with predefined dataset.

URL structure is:

• http://127.0.0.1:9400/tests/basic
• http://127.0.0.1:9400/tests/validation
• etc.

To run the tests locally using WP Playground:

1. bun run test:e2e:playground - creates a new WP Playground instance and imports the dataset.
2. bun run test:e2e:ui or bun run test:e2e - runs the tests in the browser UI or headless mode.
3. bun run test:e2e:report:show - shows the test report.
4. bun run test:e2e:report:pdf - generates a PDF report of the tests.

Setting up custom test environment:

1. Create a new WordPress installation.
2. Install the Eightshift Forms plugin.
3. Check the options for the forms set in the tests/e2e/playground/playground.json file.
4. Import the dataset from the tests/e2e/playground/dataset.xml file, make sure you have a clean installation before importing the dataset as the page/forms ID increments remains the same as in the dataset.
5. Run ES_URL=https://<test-environment>/ bun run test:e2e:ui to run the tests.

Available environment variables:

• ES_URL: URL of the test environment. Required.
• ES_CLASS: Class name to be added to the body tag for additional styling if needed. Default is es-forms-tests.

🛟 Getting help

If you have any questions or problems, please open an issue on GitHub.

When submitting issues or otherwise participating in development, please follow our code of conduct, and fill out the issue template properly. We'll do our best to answer your issues as quickly as humanly possible: following these steps helps us out a lot in doing that.

👩‍💻 Maintainers 🧑‍💻

Eightshift Forms is maintained and sponsored by Infinum.

⚖️ License

Eightshift Forms by Infinum. It is free software, and may be redistributed under the terms specified in the LICENSE file.