Implement Docker image (#7)

.github/workflows/ci-cd.yaml

@@ -24,6 +24,7 @@ jobs:
   yml-md-style-and-link-checks:
     uses: QubitPi/hashistack/.github/workflows/yml-md-style-and-link-checks.yml@master
     with:
+      use-custom-lycheeignore-file: true
       use-custom-yamllint-config-file: true
       use-custom-markdownlint-config-file: true
 
@@ -71,9 +72,67 @@ jobs:
           NEO4J_USERNAME: not used
           NEO4J_PASSWORD: not used
 
+  docker:
+    name: Test Docker build and publish image to DockerHub
+    needs: yml-md-style-and-link-checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Startup a Neo4J database
+        run: docker run --publish=7474:7474 --publish=7687:7687 --env=NEO4J_AUTH=none --name data-loader --env=NEO4J_ACCEPT_LICENSE_AGREEMENT=yes neo4j:5.23.0-enterprise &
+      - name: Wait for database to be ready
+        uses: iFaxity/wait-on-action@v1
+        with:
+          resource: http://localhost:7474
+      - name: Load all languages into the intermediate container
+        run: |
+          pip3 install --upgrade --force-reinstall wilhelm-python-sdk
+          python3 .github/load_german.py
+          python3 .github/load_ancient_greek.py
+          python3 .github/load_latin.py
+        env:
+          NEO4J_URI: neo4j://localhost:7687
+          NEO4J_DATABASE: neo4j
+          NEO4J_USERNAME: not used
+          NEO4J_PASSWORD: not used
+      - name: Copy over data onto host
+        run: docker cp data-loader:/data .
+      - name: Test image build
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: false
+      - name: Login to DockerHub
+        if: github.ref == 'refs/heads/master'
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Push image to DockerHub
+        if: github.ref == 'refs/heads/master'
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/wilhelm-vocabulary:latest
+      - name: Push image Description
+        if: github.ref == 'refs/heads/master'
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: jack20191124
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: ${{ secrets.DOCKERHUB_USERNAME }}/wilhelm-vocabulary
+          readme-filepath: README.md
+
   cleanup-neo4j:
     if: github.ref == 'refs/heads/master'
-    needs: tests
+    needs: [tests, docker]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.lycheeignore

@@ -0,0 +1 @@
+http://localhost:7474

Dockerfile

@@ -0,0 +1,20 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+FROM neo4j:5.23.0-enterprise
+
+LABEL maintainer="Jiaqi (Jack) Liu"
+LABEL maintainer-email="jack20220723@gmail.com"
+
+RUN rm -rf /var/lib/neo4j/data
+COPY data/ /var/lib/neo4j/data

README.md

@@ -2,8 +2,36 @@ Wilhelm Vocabulary
 ==================
 
 [![GitHub workflow status badge][GitHub workflow status badge]][GitHub workflow status URL]
+[![Docker Hub][Docker Hub badge]][Docker Hub URL]
 [![Apache License Badge]][Apache License, Version 2.0]
 
+<!-- TOC -->
+
+- [Wilhelm Vocabulary](#wilhelm-vocabulary)
+  - [Data Format](#data-format)
+    - [Encoding Table in YAML](#encoding-table-in-yaml)
+  - [Data Pipeline](#data-pipeline)
+  - [How Data (Vocabulary) is Stored in a Graph Database](#how-data-vocabulary-is-stored-in-a-graph-database)
+    - [Why Graph Database](#why-graph-database)
+    - [Base Schema](#base-schema)
+    - [Docker](#docker)
+      - [Interesting Queries](#interesting-queries)
+  - [Languages](#languages)
+    - [German](#german)
+      - [Noun Declension](#noun-declension)
+        - [Declension Template](#declension-template)
+    - [Ancient Greek](#ancient-greek)
+      - [Diacritic Mark Convention](#diacritic-mark-convention)
+      - [Noun Declension](#noun-declension-1)
+      - [Adjective Declension](#adjective-declension)
+      - [Verb Conjugation](#verb-conjugation)
+    - [Latin](#latin)
+    - [Classical Hebrew (Coming Soon)](#classical-hebrew-coming-soon)
+    - [Korean](#korean)
+  - [License](#license)
+
+<!-- TOC -->
+
 Data Format
 -----------
 
@@ -135,7 +163,32 @@ the German noun "[Ecke](https://en.wiktionary.org/wiki/Ecke#Noun)" has at least
 
 ### Docker
 
-More details TBA.
+A Docker image has been made to allow us to explore the vocabulary in Neo4J browser backed by a Neo4J database in
+container. To get the image and run the container, simply do:
+
+```console
+docker run \
+    --publish=7474:7474 \
+    --publish=7687:7687 \
+    --env=NEO4J_AUTH=none \
+    --env=NEO4J_ACCEPT_LICENSE_AGREEMENT=yes \
+    -e NEO4JLABS_PLUGINS=\[\"apoc\"\] \
+    jack20191124/wilhelm-vocabulary
+```
+
+> [!NOTE]
+>
+> The image is based on Neo4J Enterprise 5.23.0.
+
+- When container starts, access neo4j through browser at http://localhost:7474
+- Both __bolt://__ and __neo4j://__ protocols are fine.
+- Choose __No authentication__ for _Authentication type_
+- Then hit __Connect__ as shown below
+
+![Connecting to Neo4J Docker](./neo4j-docker-connect.png "Error loading neo4j-docker-connect.png")
+
+We have offered some queries that can be used to quickly explore our language data in the
+[next section](#interesting-queries)
 
 #### Interesting Queries
 
@@ -411,5 +464,8 @@ The use and distribution terms for [wilhelm-vocabulary]() are covered by the [Ap
 [Apache License Badge]: https://img.shields.io/badge/Apache%202.0-F25910.svg?style=for-the-badge&logo=Apache&logoColor=white
 [Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
 
+[Docker Hub badge]: https://img.shields.io/badge/DockerHub-2596EC?style=for-the-badge&logo=docker&logoColor=white
+[Docker Hub URL]: https://hub.docker.com/r/jack20191124/wilhelm-vocabulary
+
 [GitHub workflow status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/wilhelm-vocabulary/ci-cd.yaml?branch=master&style=for-the-badge&logo=github&logoColor=white&label=Database%20Loading
 [GitHub workflow status URL]: https://github.com/QubitPi/wilhelm-vocabulary/actions/workflows/ci-cd.yaml