-# org.civicrm.afform (Early Proof of Concept)
+# Form builder (afform)
-<!--  -->
+
The Affable Administrative Angular Form Framework (`afform`) is a system for administering AngularJS-based forms
in CiviCRM which:
1. Allows developers to declaratively define a canonical, baseline form using AngularJS.
-2. Allows administrators (or administrative tools) to use the CRUD API to customize the forms.
+2. Allows administrators (or administrative GUI tools) to use the CRUD API to customize the forms.
3. Allows developers (or administrators/tools) to embed these forms in other CiviCRM-AngularJS apps.
4. Allows developers to apply change-sets via hook. (*WIP; pending upstream support*)
-This extension is a proof-of-concept. It aims to demonstrate the core model/concept -- however, there are
+This extension is a proof-of-concept. It aims to demonstrate the core model/concept -- however, there are
[known issues and additional components](docs/roadmap.md) to address, and some documentation will be easier to approach
if you already have a basic understanding of CiviCRM API and AngularJS. It is licensed under [AGPL-3.0](LICENSE.txt).
## Requirements
-* PHP v5.4+
-* CiviCRM v5.3+
+* PHP v7.2+
+<!--
## Installation (Web UI)
-This extension has not yet been published for installation via the web UI.
+This extension ships with core and when it matures will eventually
+be enabled by default on new installs and at some point required.
## Installation (CLI, Zip)
cd <extension-dir>
cv dl org.civicrm.afform@https://github.com/totten/afform/archive/master.zip
```
+-->
## Installation (CLI, Git)
-Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
+Sysadmins and developers may enable afform via the UI extensions page or
install it with the command-line tool [cv](https://github.com/civicrm/cv).
```bash
-git clone https://github.com/totten/afform.git
cv en afform
```
projects / civicrm-core.git / blobdiff