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