MODELINKS-1 Prepare base structure for module

.gitattributes

@@ -0,0 +1,4 @@
+* text=auto
+
+# use always lf end of lines for bash scripts
+*.sh text eol=lf

.gitignore

@@ -1,23 +1,38 @@
-# Compiled class file
-*.class
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+bin/
+.checkstyle
 
-# Log file
-*.log
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
 
-# BlueJ files
-*.ctxt
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
 
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
 
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
+### VS Code ###
+.vscode/
 
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
+### Development
+application-local.yml

CODEOWNERS

@@ -0,0 +1 @@
+* @folio-org/spitfire-backend

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contribution guidelines
+
+Guidelines for Contributing Code:
+[dev.folio.org/guidelines/contributing](https://dev.folio.org/guidelines/contributing)

Dockerfile

@@ -0,0 +1,11 @@
+FROM folioci/alpine-jre-openjdk17:latest
+
+# Copy your fat jar to the container
+ENV APP_FILE mod-entity-links.jar
+# - should be a single jar file
+ARG JAR_FILE=./target/*.jar
+# - copy
+COPY ${JAR_FILE} ${JAVA_APP_DIR}/${APP_FILE}
+
+# Expose this port locally in the container.
+EXPOSE 8081

Jenkinsfile

@@ -0,0 +1,19 @@
+buildMvn {
+  publishModDescriptor = true
+  mvnDeploy = true
+  doKubeDeploy = true
+  buildNode = 'jenkins-agent-java17'
+
+  doApiLint = true
+  doApiDoc = true
+  apiTypes = 'OAS'
+  apiDirectories = 'src/main/resources/swagger.api'
+
+  doDocker = {
+    buildDocker {
+      publishMaster = true
+      healthChk = false
+      healthChkCmd = 'curl -sS --fail -o /dev/null  http://localhost:8081/apidocs/ || exit 1'
+    }
+  }
+}

NEWS.md

@@ -0,0 +1,2 @@
+## 1.0.0-SNAPSHOT
+[MODELINKS-1](https://issues.folio.org/browse/MODELINKS-1) - Prepare base structure for module

PERSONAL_DATA_DISCLOSURE.md

@@ -0,0 +1,58 @@
+
+
+## Overview
+The purpose of this form is to disclose the types of personal data stored by each module.  This information enables those hosting FOLIO to better manage and comply with various privacy laws and restrictions, e.g. GDPR.
+
+It's important to note that personal data is not limited to that which can be used to identify a person on it's own (e.g. Social security number), but also data used in conjunction with other data to identify a person (e.g. date of birth + city + gender).
+
+For the purposes of this form, "store" includes the following:
+* Persisting to storage - Either internal (e.g. Postgres) or external (e.g. S3, etc.) to FOLIO
+* Caching - In-memory, etc.
+* Logging
+* Sending to an external piece of infrastructure such as a queue (e.g. Kafka), search engine (e.g. Elasticsearch), distributed table, etc.
+
+## Personal Data Stored by This Module
+- [ ] This module does not store any personal data.
+- [ ] This module provides [custom fields](https://github.com/folio-org/folio-custom-fields).
+- [ ] This module stores fields with free-form text (tags, notes, descriptions, etc.)
+- [ ] This module caches personal data
+---
+- [ ] First name
+- [ ] Last name
+- [ ] Middle name
+- [ ] Pseudonym / Alias / Nickname / Username / User ID
+- [ ] Gender
+- [ ] Date of birth
+- [ ] Place of birth
+- [ ] Racial or ethnic origin
+- [ ] Address
+- [ ] Location information
+- [ ] Phone numbers
+- [ ] Passport number / National identification numbers
+- [ ] Driver’s license number
+- [ ] Social security number
+- [ ] Email address
+- [ ] Web cookies
+- [ ] IP address
+- [ ] Geolocation data
+- [ ] Financial information
+- [ ] Logic or algorithms used to build a user/profile
+<!--- - [ ] Other personal data - Please list as needed -->
+<!--- - [ ] Other personal data - Please list as needed -->
+
+**NOTE** This is not intended to be a comprehensive list, but instead provide a starting point for module developers/maintainers to use.
+
+## Privacy Laws, Regulations, and Policies
+The following laws and policies were considered when creating the list of personal data fields above.
+* [General Data Protection Regulation (GDPR)](https://gdpr.eu/)
+* [California Consumer Privacy Act (CCPA)](https://oag.ca.gov/privacy/ccpa)
+* [U.S. Department of Labor: Guidance on the Protection of Personal Identifiable Information](https://www.dol.gov/general/ppii)
+* Cybersecurity Law of the People's Republic of China
+    * https://www.newamerica.org/cybersecurity-initiative/digichina/blog/translation-cybersecurity-law-peoples-republic-china/
+    * http://en.east-concord.com/zygd/Article/20203/ArticleContent_1690.html?utm_source=Mondaq&utm_medium=syndication&utm_campaign=LinkedIn-integration
+* [Personal Data Protection Bill, 2019 (India)](https://www.prsindia.org/billtrack/personal-data-protection-bill-2019)
+* [Data protection act 2018 (UK)](https://www.legislation.gov.uk/ukpga/2018/12/section/3/enacted)
+
+---
+
+v1.0

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## Purpose
+_Describe the purpose of the pull request._
+
+## Approach
+_How does this change fulfill the purpose?_
+
+### Changes checklist
+- [ ] API paths, methods, request or response bodies changed, added, or removed
+- [ ] Database schema changes
+- [ ] Interface versions changes
+- [ ] Interface dependencies added, or removed
+- [ ] Permissions changed, added, or removed
+
+### TODOS and Open Questions
+- [ ] Use GitHub checklists. When solved, check the box and explain the answer.
+
+### Learning
+_Describe the research stage. Add links to blog posts, patterns, libraries or addons used to solve this problem._

README.md

@@ -1,2 +1,6 @@
-# mod-links
-Backend for storing linkage between MARCs
+# mod-search
+
+Copyright (C) 2020-2021 The Open Library Foundation
+
+This software is distributed under the terms of the Apache License,
+Version 2.0. See the file "[LICENSE](LICENSE)" for more information.