README

A composer plugin that makes installing Gravity Forms with composer easier.

It reads your 🔑 Gravity Forms key from the environment or a .env file.

Usage

This plugin is compatible with Both Composer 2.x (latest) and 1.x

1. Add our Gravity Forms Composer Bridge repository to the repositories field in composer.json

This repository simply provides a periodically updated packages.json, that redirects composer to the provided downloads. Note that this repository does not provide any Gravity Forms packages itself, it only tells Composer where it can find packages. Secondly it is important to note that your license key is not submitted to the repository, since the installer downloads the zip files directly from servers.

Why this repository?

Since it enables you to use gravityforms/gravityforms package with version constraints like any normal Packagist package.

{
  "type": "composer",
  "url": "https://arnaud-ritti.github.io/gravityforms-composer-bridge/composer/v1/wordpress-plugin/"
}

This installs the package as wordpress-plugin type, in case you want a different type, use the following URL:

wordpress-muplugin:

https://arnaud-ritti.github.io/gravityforms-composer-bridge/composer/v1/wordpress-muplugin/

wpackagist-plugin:

https://arnaud-ritti.github.io/gravityforms-composer-bridge/composer/v1/wpackagist-plugin/

library:

https://arnaud-ritti.github.io/gravityforms-composer-bridge/composer/v1/library/

2. Make your key available

There are 3 ways to make the GRAVITYFORMS_KEY available:

Using the GRAVITYFORMS_KEY environment variable
.env file
Setting gravityforms-key in $COMPOSER_HOME/config.json

Select the one that best matches your setup:

2.a Using the GRAVITYFORMS_KEY Environment variable

Set the environment variable GRAVITYFORMS_KEY to your Gravity Forms key.

2.b Use a .env file

Alternatively you can add an entry to your .env file:

# .env (same directory as composer.json)
GRAVITYFORMS_KEY=Your-Key-Here

2.c. Setting the key in $COMPOSER_HOME/config.json

You specify the gravityforms-key in the config section of your $COMPOSER_HOME/config.json

{
  "config": {
    "gravityforms-key": "Your-Key-Here"
  }
}

$COMPOSER_HOME is a hidden, global (per-user on the machine) directory that is shared between all projects. By default it points to C:\Users\<user>\AppData\Roaming\Composer on Windows and /Users/\<user\>/.composer on macOS. On *nix systems that follow the XDG Base Directory Specifications, it points to $XDG_CONFIG_HOME/composer. On other *nix systems, it points to /home/\<user\>/.composer.

3. Require Gravity Forms

composer require gravityforms/gravityforms

3.b. Install add-on

composer require gravityforms/<slug>

Example :

composer require gravityforms/activecampaign

arnaud-ritti / gravityforms-installer

Maintainers

Details

README

Usage