projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 02051df8 | 1 | # org.civicrm.afform (Early Proof of Concept) |
| 66aa0f5e | 2 | |
| b9e5de69 | 3 | <!--  --> |
| 66aa0f5e | 4 | |
| 83291832 TO |
5 | The Affable Administrative Angular Form Framework (`afform`) is a system for administering AngularJS-based forms |
| 6 | in CiviCRM which: | |
| 7 | ||
| 6d404d90 | 8 | 1. Allows developers to declaratively define a canonical, baseline form using AngularJS. |
| 3dc7610d | 9 | 2. Allows administrators (or administrative tools) to use the CRUD API to customize the forms. |
| 6d404d90 | 10 | 3. Allows developers (or administrators/tools) to embed these forms in other CiviCRM-AngularJS apps. |
| b9e5de69 | 11 | 4. Allows developers to apply change-sets via hook. (*WIP; pending upstream support*) |
| 66aa0f5e | 12 | |
| 8a0ffdf9 TO |
13 | This extension is a proof-of-concept. It aims to demonstrate the core model/concept -- however, there are |
| 14 | [known issues and additional components](docs/roadmap.md) to address, and some documentation will be easier to approach | |
| 15 | if you already have a basic understanding of CiviCRM API and AngularJS. It is licensed under [AGPL-3.0](LICENSE.txt). | |
| 66aa0f5e TO |
16 | |
| 17 | ## Requirements | |
| 18 | ||
| 19 | * PHP v5.4+ | |
| 83291832 | 20 | * CiviCRM v5.3+ |
| 66aa0f5e TO |
21 | |
| 22 | ## Installation (Web UI) | |
| 23 | ||
| 24 | This extension has not yet been published for installation via the web UI. | |
| 25 | ||
| 26 | ## Installation (CLI, Zip) | |
| 27 | ||
| 28 | Sysadmins and developers may download the `.zip` file for this extension and | |
| 29 | install it with the command-line tool [cv](https://github.com/civicrm/cv). | |
| 30 | ||
| 31 | ```bash | |
| 32 | cd <extension-dir> | |
| 1abc2be1 | 33 | cv dl org.civicrm.afform@https://github.com/totten/afform/archive/master.zip |
| 66aa0f5e TO |
34 | ``` |
| 35 | ||
| 36 | ## Installation (CLI, Git) | |
| 37 | ||
| 38 | Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and | |
| 39 | install it with the command-line tool [cv](https://github.com/civicrm/cv). | |
| 40 | ||
| 41 | ```bash | |
| 1abc2be1 | 42 | git clone https://github.com/totten/afform.git |
| 66aa0f5e TO |
43 | cv en afform |
| 44 | ``` | |
| 45 | ||
| 7d7b13d7 | 46 | ## Developer Documentation |
| 66aa0f5e | 47 | |
| 8a0ffdf9 | 48 | * [Quick Start: Creating the canonical definition of a basic form](docs/quickstart.md) |
| 64423b13 TO |
49 | * [Writing Forms: Afform as basic AngularJS templates](docs/writing.md) (With example: *Contact Record*) |
| 50 | * [Embedding Forms: Afform as reusable building-block](docs/embed.md) (With example: *Contact Record*) | |
| 8a0ffdf9 | 51 | * [Form CRUD: Updating forms via programmatic API](docs/crud.md) |
| b9e5de69 | 52 | * [Form Hooks: Updating forms via declarative selector](docs/alter.md) (*WIP; pending upstream support*) |
| 8a0ffdf9 TO |
53 | * [Full AngularJS: Integrating between Afform and vanilla AngularJS](docs/angular.md) |
| 54 | * [Roadmap and Known Issues](docs/roadmap.md) | |
| b9e5de69 | 55 | * [Philosophy, Beliefs, Assumptions](docs/philosophy.md) |