/GravityView

The best, easiest way to display Gravity Forms entries on your website.

Primary LanguagePHP

GravityView (Floaty loves you!)

CircleCI

GravityView is a commercial plugin available from https://gravityview.co. The plugin is hosted here on a public GitHub repository to better facilitate community contributions from developers and users. If you have a suggestion, a bug report, or a patch for an issue, feel free to submit it here.

If you are using the plugin on a live site, please purchase a valid license from the website. We cannot provide support to anyone that does not hold a valid license key.

Installation Instructions

To install the plugin, clone this repo to your WordPress plugins folder and activate it. Alternatively, you can download the latest release to your WordPress plugins folder and then activate it.

For Developers

If you wish to make changes to the plugin, you need to install developer dependencies. First, a couple of prerequisites:

  1. Make sure that you have the full plugin source code by either cloning this repo or downloading the source code (not the versioned release) from the Releases section
  2. Install Composer
  3. Install Node.js
    • We recommend a Node.js version manager for Linux/macOS or Windows
    • Run npm install -g grunt-cli if this the first time you've installed Node.js or switched to a new version

Next, install dependencies:

  1. Run composer install to install Composer dependencies
  2. Run npm install to install Node.js dependencies

To compile/minify UI assets, use the following commands:

  1. grunt sass & grunt postcss to compile and minify CSS files
  2. grunt uglify to minify JavaScript files
  3. grunt imagemin to minify images

Unit Tests

The plugin uses PHPUnit as part of the development process. We offer preconfigured Docker containers and a custom Bash script to facilitate running tests against multiple PHP and WordPress versions in a predictable environment. Visit our Tooling repo for information regarding how to configure and run tests.

Acceptance Tests

The plugin uses Codeception for acceptance testing. To configure and run tests:

  1. Install and configure Docker
  2. Configure environment variables by running:
    • export GRAVITYFORMS_KEY=[YOUR GRAVITY FORMS KEY HERE]
    • export GRAVITYVIEW_KEY=[YOUR GRAVITYVIEW KEY HERE]
    • export PLUGIN_DIR=[/path/to/gravityview]
  3. Finally, cd to the GravityView plugin directory and run docker-compose -f tests/acceptance/docker/docker-compose.yml run codeception

See Codeception commands reference for a full list of available flags.

Acknowledgements

We are thankful to the following services and open source software that help enhance our plugin: