'chore(init): scaffolding by Yeoman'

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.github/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+
+:balloon: First off, thank you for considering contributing to 04-index. :balloon:
+
+All pull-requests are welcome. File a bug report, fix a typo, improve the documentation, or add a new feature. All are helpful, and make 04-index better.
+
+Please have a quick look at these guidelines to help both you and the developers to keep things moving smoothly.
+
+## Basic Conduct
+
+*   Please be respectful when discussing changes and issues. Consider that not everyone's first language is english.
+*   Create an issue for any major changes and enhancements that you wish to make.
+
+If this is your first time contributing to a project you might want to take a look [here](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
+
+## Getting started
+1.  Create your own fork of the code.
+
+2.  Do the changes in your fork.
+    *   Minor changes that don't impact code functionality (typos, inline comments, … ) can be done in the master branch.
+    *   Functional changes should be collected in their own branch.
+
+3.  If you like the change and think the project could use it:
+    *   Open a pull request referencing the issue describing the new feature in the comment section \([how-to](https://github.com/blog/1506-closing-issues-via-pull-requests)\).  
+
+Once your pull request has been reviewed it will be merged. You can greatly help the reviewer by:
+*   sticking to one feature per pull request.
+*   use [meaningful](https://chris.beams.io/posts/git-commit/) commit messages inside your feature branch.
+*   filling out the pull request & issue templates.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: ''
+assignees: ''
+
+---
+
+### Expected behavior
+
+### Actual behavior
+
+### Reproduction steps
+
+### Please provide the following
+*   Java Version:
+*   exist-db version:
+*   04-index version:
+*   OS version: 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+### Your Ideal Solution
+
+### Any Alternative Options
+
+### Additional Context

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+### Thank you for your Pull Request
+
+If you're adding a new feature, please adjust / add tests covering your code changes. You can reference any related issues below.
+
+Fixes #

.github/workflows/exist.yml

@@ -0,0 +1,97 @@
+# This workflow builds a xar archive, deploys it into exist and execute its test suites.
+# It also includes code for using semantic-release to upload packages as part of GitHub releases
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: exist-db CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+       matrix:
+         exist-version: [latest, release]
+         java-version: [8]
+         node-version: ['14', '16']
+    # TODO: see #563 could still be usefull for gulp builds 
+    # services:
+    #   # Label used to access the service container
+    #   exist:
+    #     image: existdb/existdb:${{ matrix.exist-version}}
+    #     ports:
+    #       - 8080:8080
+
+    steps:
+      # Checkout code
+      - uses: actions/checkout@v2
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-        
+
+      # Build Frontend
+      - name: Build Frontend Using Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - run: npm ci
+
+      # Build Expath Package 
+      # TODO: #563 make optional for gulp builds
+      - name: Build Expath Package
+        uses: actions/setup-java@v1
+        with:
+          java-version: ${{ matrix.java-version }}
+      - run: ant 
+
+      # Deploy Package in Container
+      - name: Pull Base Image
+        run: docker pull existdb/existdb:${{ matrix.exist-version }}
+
+      - name: Create CI Container
+        run: docker create  --name exist-ci -p 8080:8080 existdb/existdb:${{ matrix.exist-version }} 
+
+      - name: Prep CI Container
+        run: docker cp ./build/*-dev.xar exist-ci:exist/autodeploy
+
+      - name: Start Exist Container
+        run: docker start exist-ci && sleep 30
+
+      # Testing 
+      - name: Run Unit Tests     
+        run: npm test
+
+      - name: Run Integration Tests  
+        run: npm run cypress
+
+  # TODO: Add upload to dockerhub   
+  # release:
+  #   name: Release
+  #   runs-on: ubuntu-latest
+  #   needs: build
+  #   if: github.ref == 'refs/heads/main'
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v2
+  #       with:
+  #         fetch-depth: 0
+  #     - name: Setup Node.js
+  #       uses: actions/setup-node@v2
+  #       with:
+  #         node-version: 14
+  #         cache: 'npm'
+  #     - name: Install dependencies
+  #       run: npm ci
+  #     - name: Create package
+  #       run: npm run build
+  #     - name: Release
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #       run: npx semantic-release
+
+

.gitignore

@@ -0,0 +1,165 @@
+# =========================
+# Operating System Files
+# =========================
+
+# Windows image file caches
+ Thumbs.db
+ ehthumbs.db
+
+# Folder config file
+ Desktop.ini
+
+# Recycle Bin used on file shares
+ $RECYCLE.BIN/
+
+# Windows Installer files
+ *.cab
+ *.msi
+ *.msm
+ *.msp
+
+# Windows shortcuts
+ *.lnk
+
+# =========================
+# OSX
+# =========================
+
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# =========================
+# Files that might appear in the root of a volume
+# =========================
+
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+# Network Trash Folder
+Temporary Items
+.apdisk
+
+
+# =========================
+# Application Files
+# =========================
+
+~$*.xlsx
+.~lock*
+
+# =========================
+# exist-db specific files
+# =========================
+
+*.xar
+.existdb.json
+query-results
+
+# =========================
+# other
+# =========================
+.env
+.yo-rc.json
+node_modules/
+coverage/
+build/
+bower_components/
+reports/
+
+# =========================
+# tei-pub (gulp)
+# =========================
+webtest/bin
+webtest/reports
+webtest/errorShots
+
+##############################
+## Java
+##############################
+.mtj.tmp/
+*.class
+*.jar
+*.war
+*.ear
+*.nar
+hs_err_pid*
+
+##############################
+## Maven
+##############################
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+pom.xml.bak
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+.mvn/wrapper/maven-wrapper.jar
+
+##############################
+## Gradle
+##############################
+bin/
+build/
+.gradle
+.gradletasknamecache
+gradle-app.setting
+!gradle-wrapper.jar
+
+##############################
+## IntelliJ
+##############################
+out/
+.idea/
+.idea_modules/
+*.iml
+*.ipr
+*.iws
+
+##############################
+## Eclipse
+##############################
+.settings/
+bin/
+tmp/
+.metadata
+.classpath
+.project
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.loadpath
+.factorypath
+
+##############################
+## NetBeans
+##############################
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+nbactions.xml
+nb-configuration.xml
+
+##############################
+## Visual Studio Code
+##############################
+.vscode/
+*.code-workspace

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 djbpitt <[email protected]> (http://www.obdurodon.org)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.