Merge pull request #605 from duncdrum/rm-poly2

remove deprecated polymer2 code
eXist-db · Feb 2, 2021 · e07e5e5 · e07e5e5
2 parents fd3d2aa + a98b705
commit e07e5e5
Show file tree

Hide file tree

Showing 20 changed files with 253 additions and 905 deletions.
diff --git a/README.md b/README.md
@@ -67,6 +67,222 @@ Note: If you told yeoman to use Github for your new project, your project will s
 
 Some of the answers, such as username will be stored after the initial run of the generator. So you only have to type them once.
 
+### The Scaffold
+
+The generator creates sensible default structures for `expath` packages for exist-db, which includes default folders for `xquery` code, meta-data files, `html`, etc. modelled on eXide's package generation scripts. In addition there are optional features such as `dockerfile`, CI scripts, github templates, secure area, … depending on the options selected by the user. The idea is that if you select e.g. to include a secure area in your application from the start, the files will contain the necessary parts, after the intial run of the generator. Saving you from having to manualy add sections, or repeatedly providing the same information over and over agian. There are 4 basic app types.
+
+-   exist-design
+-   plain
+-   empty
+-   xquery library
+
+Since if would be impractical to go through all possible combinations of option here are some sample scaffolds created with the generator.
+
+#### exist-design (with. secure area selected)
+
+```shell
+├── Dockerfile
+├── LICENSE
+├── README.md
+├── admin
+│   ├── controller.xql
+│   ├── index.html
+│   └── security.html
+├── build
+│   ├── exide_demo-1.0.0-dev.xar
+│   └── exide_demo-1.0.0.xar
+├── build.xml
+├── collection.xconf
+├── controller.xql
+├── cypress.json
+├── error-page.html
+├── expath-pkg.xml
+├── icon.png
+├── index.html
+├── modules
+│   ├── app.xql
+│   ├── config.xqm
+│   └── view.xql
+├── node_modules
+│   └── pruned …
+├── package-lock.json
+├── package.json
+├── post-install.xql
+├── pre-install.xql
+├── repo.xml
+├── reports
+│   ├── screenshots
+│   └── videos
+├── resources
+│   ├── css
+│   │   └── style.css
+│   └── images
+│       ├── bgmenu.gif
+│       ├── bgmenuhi.gif
+│       ├── body-base.gif
+│       ├── body.gif
+│       ├── bold.gif
+│       ├── code.gif
+│       ├── delete-icon.png
+│       ├── existdb.png
+│       ├── glyphicons-halflings.png
+│       ├── grey-box-bot.gif
+│       ├── grey-box-rpt.gif
+│       ├── grey-box-top.gif
+│       ├── header.gif
+│       ├── horizontal.gif
+│       ├── italic.gif
+│       ├── nav-dropdown.gif
+│       ├── nav-dropdown.png
+│       ├── nav.gif
+│       └── page-edit-icon.png
+├── templates
+│   ├── login-panel.html
+│   └── page.html
+└── test
+    ├── cypress
+    │   ├── fixtures
+    │   │   └── example.json
+    │   ├── integration
+    │   │   ├── landing_spec.js
+    │   │   ├── login-fail_spec.js
+    │   │   └── login-ok_spec.js
+    │   ├── plugins
+    │   │   └── index.js
+    │   └── support
+    │       ├── commands.js
+    │       └── index.js
+    ├── mocha
+    │   ├── app_spec.js
+    │   └── rest_spec.js
+    └── xqs
+        ├── test-runner.xq
+        ├── test-suite.xql
+        └── xqSuite.js
+```
+
+#### plain (with most options)
+
+```shell
+├── LICENSE
+├── README.md
+├── build
+│   ├── plain_demo-1.0.0-dev.xar
+│   └── plain_demo-1.0.0.xar
+├── build.xml
+├── collection.xconf
+├── controller.xql
+├── cypress.json
+├── error-page.html
+├── expath-pkg.xml
+├── icon.png
+├── index.html
+├── modules
+│   ├── app.xql
+│   ├── config.xqm
+│   └── view.xql
+├── node_modules
+│   └── pruned …
+├── package-lock.json
+├── package.json
+├── post-install.xql
+├── pre-install.xql
+├── repo.xml
+├── reports
+│   ├── screenshots
+│   └── videos
+├── resources
+│   └── css
+│       └── style.css
+├── templates
+│   └── page.html
+└── test
+    ├── cypress
+    │   ├── fixtures
+    │   │   └── example.json
+    │   ├── integration
+    │   │   └── landing_spec.js
+    │   ├── plugins
+    │   │   └── index.js
+    │   └── support
+    │       ├── commands.js
+    │       └── index.js
+    ├── mocha
+    │   ├── app_spec.js
+    │   └── rest_spec.js
+    └── xqs
+        ├── test-runner.xq
+        ├── test-suite.xql
+        └── xqSuite.js
+```
+
+#### empty (without extras)
+
+```shell
+├── LICENSE
+├── build
+│   ├── empty_demo-1.0.0-dev.xar
+│   └── empty_demo-1.0.0.xar
+├── build.xml
+├── cypress.json
+├── expath-pkg.xml
+├── icon.png
+├── node_modules
+│   └── pruned …
+├── package-lock.json
+├── package.json
+├── repo.xml
+├── reports
+│   ├── screenshots
+│   └── videos
+└── test
+    ├── cypress
+    │   ├── fixtures
+    │   │   └── example.json
+    │   ├── integration
+    │   │   └── landing_spec.js
+    │   ├── plugins
+    │   │   └── index.js
+    │   └── support
+    │       ├── commands.js
+    │       └── index.js
+    ├── mocha
+    │   ├── app_spec.js
+    │   └── rest_spec.js
+    └── xqs
+        ├── test-runner.xq
+        ├── test-suite.xql
+        └── xqSuite.js
+```
+
+#### xquery library
+
+```shell
+├── LICENSE
+├── README.md
+├── build
+│   ├── lib_demo-1.0.0-dev.xar
+│   └── lib_demo-1.0.0.xar
+├── build.xml
+├── collection.xconf
+├── expath-pkg.xml
+├── node_modules
+│   └── pruned …
+├── package-lock.json
+├── package.json
+├── post-install.xql
+├── pre-install.xql
+├── repo.xml
+└── test
+    ├── mocha
+    │   ├── app_spec.js
+    │   └── rest_spec.js
+    └── xqs
+        ├── test-runner.xq
+        ├── test-suite.xql
+        └── xqSuite.js
+```
+
 ## Development
 
 If you want to contribute another template or option, please take a look at the issue tracker. Pull request are always welcome. This generator uses `mocha` for unit testing. Please make sure to add tests when opening a PR.