> For the complete documentation index, see [llms.txt](https://performantlabs.gitbook.io/campaign-kit/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://performantlabs.gitbook.io/campaign-kit/administrator-documentation/installation.md).

# Installation/Uninstallation

## Installation

Campaign Kit requires [Composer](https://getcomposer.org) to manage dependencies. Campaign Kit has five modules:

* Campaign Kit
* Campaign Kit Core
* Campaign Kit Donor Wall
* Campaign Kit Queuing
* Campaign Kit Demonstration (do not install on production).

**Requirements and module dependencies (with all modules installed):**

* The latest or previous version of [Drupal](https://www.drupal.org/project/drupal)
* [Computed Field](https://www.drupal.org/project/computed_field)
* [CTools](https://www.drupal.org/project/ctools)
* [Entity](https://www.drupal.org/project/entity)
* [Entity Extra](https://www.drupal.org/project/entity_extra)
* [Entity Queue](https://www.drupal.org/project/entityqueue)
* [Form Mode Manager](https://www.drupal.org/project/form_mode_manager)
* [Hook Event Dispatcher](https://www.drupal.org/project/hook_event_dispatcher)
* [Layout Builder Restrictions](https://www.drupal.org/project/layout_builder_restrictions)
* [Pathauto](https://www.drupal.org/project/pathauto)
* [Payment](https://www.drupal.org/project/payment)
* [Payment Stripe](https://www.drupal.org/project/payment_stripe)
* [Plugin](https://www.drupal.org/project/plugin)
* [Stripe](https://www.drupal.org/project/stripe)
* [Subpathauto](https://www.drupal.org/project/subpathauto)
* [Token](https://www.drupal.org/project/token)

### Install Campaign Kit and Its Dependencies

Open the composer.json file in the project root directory and add the following to the list of required modules:

`"drupal/campaign_kit": "^1.0"`

Or from the command line use:

`composer require drupal/campaign_kit`

Campaign Kit might require patches; check the composer.json file in the module. Also, enable patching in your composer file by adding the following in the "extra" section of composer.json:

```
"enable-patching": true
```

Then:

`composer update`

## Enabling Campaign Kit

### Using the GUI

Go to `admin/modules`, set the checkbox for Campaign Kit and Campaign Kit Core and click the `Install` button.

The configuration screens are located at `admin/campaign_kit`.

Enable the module at`admin/modules`and click the `Install` button.

### Using Drush and Drupal Console

Install Campaign Kit, Campaign Kit Core, and Campaign Kit Demo.\
Run the following commands from the command line to install them.

**Drush**

`drush -y en campaign_kit`

To see examples use `drush -y en campaign_kit campaign_kit_demo`

**Drupal Console**

`drupal module:install campaign_kit`

To see examples use `drupal module:install campaign_kit campaign_kit_demo`

### Using Simplytest.me

You can try the module at Simplytest.me:

1. Pull up <http://simplytest.me>.
2. Choose Campaign Kit from the text field.
3. Click Launch Sandbox.
4. Log in with:

   Username: admin

   Password: admin
5. Click on Extend to be brought to admin/modules.
6. Enable the following modules:

   Campaign Kit\
   Campaign Kit Core

   Campaign Kit Demonstration
7. Click Install.
8. Drupal will ask permission to install additional modules. Give your assent.
9. Once everything is installed, from the top menu visit Structure | Campaign Kit. This is the primary menu for the Kit.

## Uninstallation

Uninstall the module through `admin/modules`. Campaign Kit will delete all tables and configuration it installed.

**Drush**

`drush -y pm:uninstall campaign_kit`

`drush -y pm:uninstall campaign_kit_core`

`drush -y pm:uninstall campaign_kit_queuing`

`drush -y pm:uninstall campaign_kit_demo`

**Drupal Console**

`drupal module:uninstall campaign_kit`

`drupal module:uninstall campaign_kit_core`

`drupal module:uninstall campaign_kit_queing`

`drupal module:uninstall campaign_kit_demo`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://performantlabs.gitbook.io/campaign-kit/administrator-documentation/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.