diff options
Diffstat (limited to 'Readme.md')
-rw-r--r-- | Readme.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..0d210e0 --- /dev/null +++ b/Readme.md @@ -0,0 +1,55 @@ +Flat-File Forms +=== + +Forms and Submissions managed flat-file + +Callable via REST-API + + +## Directory Structure + +- $root + - repositories/ + - $group/ + - config/ + - config.toml + - templates/ + +### $group consists of + +- $group/ + - config/ + - $form/ + +### $form consists of + +- $form/ + - config/ + - fields/ + - _fields.toml + - name.toml + - email.toml + - submissions/ + - $year + - $month + + +## config + +`config.toml` with config values +overwritten by config.toml in $group/config/ +overwritten by config.toml in $form/config/ + +### config/templates + +Templates to use when returning a pre-rendered HTML form + + +## REST-API + +`localhost:3000/$group/$group/$form` + +GET ...$form/fields + +POST ...$form + |