README.md 2.09 KB
Newer Older
jaapjansma's avatar
jaapjansma committed
1 2
# form-processor

jaapjansma's avatar
jaapjansma committed
3 4
The form processor extension gives you the ability to define business logic for handling form submissions. 
A form submission could come from the CiviMRF, external system or just a direct submission.
jaapjansma's avatar
jaapjansma committed
5

jaapjansma's avatar
jaapjansma committed
6
[See **docs** for more information](https://docs.civicrm.org/formprocessor/en/latest/).
jaapjansma's avatar
jaapjansma committed
7

jaapjansma's avatar
jaapjansma committed
8 9
The extension is licensed under [AGPL-3.0](LICENSE.txt).

jaapjansma's avatar
jaapjansma committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
## Contributing

Feel free to contribute to this extension. Create a Merge Request and also add a little description to CHANGELOG.md of what you have changed

## Releasing Process

When one of the admins think it is time to relase a new version they might do so. You can also ask them to release a new version.
Usually this when the release is being tested and put in production.

For admins creating a release those are the steps to follow:

1. Update info.xml to reflect the new version number and release date
2. Remove the 'not yet released' from CHANGELOG.md
3. Copy the changes
4. Go to tags, create a new tag and paste the changes
5. After that update info.xml to add a new version number ending with _-dev_
6. Update changelog add a heading for the new version with the text _not yet released_

jaapjansma's avatar
jaapjansma committed
28 29 30 31
## Requirements

* PHP v5.4+
* CiviCRM (*FIXME: Version number*)
miloskroulik's avatar
miloskroulik committed
32
* a compatible theme (e.g. seven) when using Drupal 8
jaapjansma's avatar
jaapjansma committed
33 34 35 36 37 38 39 40 41 42 43 44

## Installation (Web UI)

This extension has not yet been published for installation via the web UI.

## Installation (CLI, Zip)

Sysadmins and developers may download the `.zip` file for this extension and
install it with the command-line tool [cv](https://github.com/civicrm/cv).

```bash
cd <extension-dir>
jaapjansma's avatar
jaapjansma committed
45
cv dl form-processor@https://lab.civicrm.org/jaapjansma/form-procesor/repository/master/archive.zip
jaapjansma's avatar
jaapjansma committed
46 47 48 49 50 51 52 53
```

## Installation (CLI, Git)

Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
install it with the command-line tool [cv](https://github.com/civicrm/cv).

```bash
jaapjansma's avatar
jaapjansma committed
54
git clone https://lab.civicrm.org/jaapjansma/form-procesor.git
jaapjansma's avatar
jaapjansma committed
55 56 57 58 59 60 61 62 63 64
cv en form_processor
```

## Usage

(* FIXME: Where would a new user navigate to get started? What changes would they see? *)

## Known Issues

(* FIXME *)