Tech debt weaver upgrade (#443)

* add pr and issue templates

* Update .gitignore based on new designs.

Use the triple pound symbol as section separators.

Organized in this order:
1) Section
1.1) Hidden Directories
1.2) Directories
1.3) Hidden Files
1.4) Files
1.5) Inverse rules (same hidden to directory to file pattern is repeated for these).

* Update readme and related files.

This brings in the newer practices (which have not yet fully been ironed out yet).
An attempt is made to merge the existing documentation with this.

There may be additional changes once this processed is ironed out.

* Add Maven instructions and do some clean up.

- The deployment should also explain Maven.
- Remove or replace stale MAGPIE references.
- Don't include explicit bold in header titles.

* Standardize LICENSE and update the date.

The license is derived from https://mit-license.org/ .

* Upgrade parent project to Weaver-Webservice-Core 2.1.1-RC11.

* Clean up log files of not being used and ensure used log files are accurate and consistent.

* Update Dockerfile for consistency and related.

- Update Dockerfile for consistency.
- Update Dockerfile to combine RUN commands for better layer caching.
- Update Dockerfile to use --non-unique to both useradd and groupadd commands.
- Update Dockerfile RUN build command to utilize jar profile.
- Refactor NPM_REGISTRY_URL to NPM_REGISTRY as not an actual URL.

* Should have a docker-compose.yml with .env similar to app repos

* Update GitHub workflow step.

* Update karma.conf.js for consistency and related.

- Update karma.config.js for consistency.
- Update karma.config.js preprocessors to include index.html app/**/*.html.
- Update karma.config.js using single quotes.

* Do not have git ignore the build/ directory.

* Remove version and any references from appConfig.js.template.

* Be consistent with trailing commas.

* Add Missing node/npm files to .gitignore.

* Update .gitignore.

* Update readme, adding notes and additional links.

There is a user documentation wiki, so point to that.
Only reference the additional settings found in the deploying file.

* Update the deploying document with a more correct example.

* Siwtch to 2.x branch for weaver-ui workflow.

Co-authored-by: Kevin Day <[email protected]>
Co-authored-by: Kevin Day <[email protected]>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,37 @@
+# Description
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+**Test Configuration**:
+* Toolchain:
+* SDK:
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
         with:
           repository: TAMULib/Weaver-UI-Core
           path: weaver-ui
-          ref: 2.x-staging
+          ref: 2.x
 
       - name: "Run Weaver-UI-Core Docker Compose Registry Image"
         run: docker-compose -f $GITHUB_WORKSPACE/weaver-ui/docker-compose.yml up -d registry
@@ -34,19 +34,19 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package.json', '**/package-lock.json') }}
+          key: ${{ runner.os }}-cache-node-${{ hashFiles('**/package.json', '**/package-lock.json') }}
 
       - name: "Node Modules Cache"
         uses: actions/cache@v3
         with:
-          path: node_modules
-          key: ${{ runner.os }}-node_modules-${{ hashFiles('**/package.json', '**/package-lock.json') }}
+          path: $GITHUB_WORKSPACE/repo/node_modules
+          key: ${{ runner.os }}-cache-node_modules-${{ hashFiles('**/package.json', '**/package-lock.json') }}
 
       - name: "Maven Cache"
         uses: actions/cache@v3
         with:
           path: ~/.m2/repository
-          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          key: ${{ runner.os }}-cache-maven-${{ hashFiles('**/pom.xml') }}
 
       - name: "Setup Node"
         uses: actions/setup-node@v3
@@ -58,7 +58,7 @@ jobs:
         with:
           java-version: 11
 
-      - name: "Maven Tests"
+      - name: "Maven Test"
         env:
           NPM_CONFIG_REGISTRY: http://localhost:4873
         run: |
@@ -75,7 +75,7 @@ jobs:
         uses: MikeEdgar/github-action@raw_coverage_file
         with:
           github-token: ${{ secrets.github_token }}
-          path-to-file: repo/coveralls.json
+          path-to-file: 'repo/coveralls.json'
           coverage-format: raw
 
       # - name: "Lighthouse Report"
@@ -86,7 +86,7 @@ jobs:
       #     xvfb-run --auto-servernum npm run test:audit
 
       - name: "Deploy GH-Pages"
-        if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
         uses: JamesIves/[email protected]
         with:
           github_token: ${{ secrets.github_token }}

.gitignore

@@ -1,33 +1,105 @@
-h2/
-bin/
-public/
-target/
-private/
-attachments/
-node_modules/
-*node_modules*
-*.db
+### Git ###
+!.gitkeep
 
-.vscode/
-.apt_generated/
 
-.tmp
-.project
-.settings
+### STS ###
+.apt_generated
 .classpath
-.sass-cache
 .factorypath
-.tern-project
-.externalToolBuilders
+.project
+.settings
+.springBeans
+.sts4-cache
 
 
-logs/
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+
+/.nb-gradle/
 
+
+### VS Code ###
+.vscode/
+
+dump.rdb
+
+
+### BlueJ ###
+*.ctxt
+
+
+### OS Specific ###
 .DS_Store
+.tmp/
+
+tmp/
+
+
+### Node / NPM ###
+coverage/
+logs/
+node_modules/
+
+.npmrc
+
+npm-debug.log
 package-lock.json
 
-.env
 
-.wvr/tmp/
+### Virtual Machine ###
+hs_err_pid*
+replay_pid*
+
+
+### Java ###
+.mtj.tmp/
+
+*.class
+*.log
+
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+
+### Maven ###
+logs/
+target/
+
+.classpth
+.mvn/timing.properties
+.mvn/wrapper/maven-wrapper.jar
+.project
+
+buildNumber.properties
+dependency-reduced-pom.xml
+pom.xml.next
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+release.properties
+
+
+### Weaver ###
 dist/
-coverage/
+
+
+### Project Specific ###
+.env*
+
+!**/src/main/**
+!**/src/test/**

CONTRIBUTING.md

@@ -1,76 +1,65 @@
-# Contributing To SAGE
+<a name="readme-top"></a>
+# Contributing to Search Aggregation Engine
 
-Though SAGE is developed and maintained by Texas A&M University Libraries, we welcome community contributions. Involvement in SAGE can take many forms:
+Though *Search Aggregation Engine (SAGE)* is developed and maintained by Texas A&M University Libraries, we welcome community contributions.
+Involvement in *SAGE* can take many forms.
 
-#### Using SAGE: 
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
 
-Deploying SAGE and trying it out at your own institution is itself a way of contributing to the development process. For more information on deployment strategies please see the [relevant documentation](https://github.com/TAMULib/Sage/blob/master/README.md).
-
-#### Filing Issues: 
 
-Once you are using SAGE the creation of new issues through Github is a major method of contribution towards SAGE development. Issues can be motivated by the discovery of a bug in the software, or by the desire to see either new features added to cap or existing features behaving differently.
+## Using
 
-These three categories of issue can be submitted using the following template:
+Deploying *SAGE* and trying it out at your own institution is itself a way of contributing to the development process.
+For more information on deployment strategies please see the [Deployment Guide][deployment-guide].
 
-``` 
-[*] Bug Report
-[] Feature Enhancement
-[] Feature Request
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
 
-Current Behavior:
 
-[A description of the current behavior. This could include a list of steps to reproduce in the instance of a 
-Bug Report, and can be 'N/A' for Feature Requests]
+## Filing Issues
 
-Desired Behavior:
+Once you are using *SAGE* the creation of new issues through GitHub is a major method of contribution towards *SAGE* development.
+Issues can be motivated by the discovery of a bug in the software, or by the desire to see either new features added or see changes to existing features.
 
-[A description of the expected/desired behavior of the application]
+There are two primary types of issues:
+1. Bug Report
+2. Feature Request
 
+A **Bug Report** involves a problem with the existing software or a **Feature** is not working as designed or expected.
 
-Relevant Information:
+A **Feature** involves new functionality or behavior.
 
-[This section can include relevant error messages, or links to information that pertains to the issue]
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
 
-````
 
-Once an issue has been filed it will be curated by a SAGE developer and receive the appropriate labeling.
+## Creating a Pull Request
 
-#### Creating Pull Requests:
+Community code and documentation contributions are welcome and should take the form of a **GitHub Pull Request** (*PR*).
+Each *PR* will need to be reviewed by a *SAGE* developer.
+A review will result in the *PR* being accepted and merged, a descriptive request for changes, or the *PR* being closed along with a detailed explanation.
 
-Community code and documentation contributions are welcome, and should take the form of a Github Pull Request (PR). Each PR will need to be reviewed by a SAGE developer. A review will result in the PR being accepted and merged, a descriptive request for changes, or the PR being closed along with a detailed explanation.
+It is our intention to maintain labeling on issues that are deemed to be low difficulty in order to provide a good point of entry for those looking to begin contributing code or documentation.
 
-It is our intention to maintain labeling on issues that are deemed to be low difficulty, in order to provide a good point of entry for those looking to begin contributing code or documentation.
+A *PR* description should include a list of the specific issues resolved, the predicted *semantic versioning* impact of the changes, and a description which characterizes the nature of the changes made.
+When creating a *PR*, an issue template is automatically provided to simplify this process.
 
-A PR description should include a list of the specific issues resolved, the predicted semantic versioning impact of the changes and a description which characterizes the nature of the changes made.
+For more information about *semantic versioning* please see [Semantic Versioning Website][semantic-versioning].
+In general keep in mind:
 
-For more information about semantic versioning please see [this reference](https://semver.org/). In general keep in mind:
+- A **Major Change** is a breaking change that is not backwards compatible.
+- A **Minor Change** is a non-breaking change that is backwards compatible to the last **Major Change**.
+- A **Patch** is a trivial change or bug fix that should not impact compatibility.
 
-- A Major Change is a breaking change that is not backwards compatible.
-- A Minor Change is a non breaking change that is backwards compatible to the last major change.
-- A Patch is a trivial change or bug fix that should not impact compatibility
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
 
-Please confirm you PR description to the following template:
 
-```
-Resolves:
+## Good Luck!
 
-- [List of # references to specific issues addressed by this PR]
+We look forward to seeing your contributions.
+If you have any additional questions please contact the *SAGE* developers at [email protected].
 
-Changes:
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
 
-[*] Major
-[] Minor
-[] Patch
 
-[A description of the approach taken to resolving those issues]
-
-```
-
-In addition to a well formatted PR we would also appreciate granular commits with descriptive messages. For instance a good commit message may be `Moved /foo endpoint logic into a FooService`, whereas `Everything I did Friday` is less granular or descriptive.
-
-If your commits do not conform to these recommendations you might consider rebasing your PR. Instructions for how this might work can be found [here](https://help.github.com/articles/about-git-rebase/).
-
-
-#### Good Luck!
-
-We look forward to seeing your contributions. If you have any additional questions please contact the SAGE developers at [[email protected]]().
+<!-- LINKS -->
+[deployment-guide]: DEPLOYING.md
+[semantic-versioning]: https://semver.org/