diff --git a/.dockerignore b/.dockerignore index b86af5e..a7b169c 100644 --- a/.dockerignore +++ b/.dockerignore @@ -10,3 +10,5 @@ docker-compose.yml README.md LICENSE.txt public/cache +app/Assets/frontpage-assets/.git +app/Assets/frontpage-assets/files diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 50fe92b..d783591 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,6 +11,8 @@ jobs: COMPOSE_PROJECT_NAME: ci-${{ github.job }}-${{ github.run_id }} steps: - uses: actions/checkout@v4 + with: + submodules: true - name: Build services run: docker compose build @@ -34,6 +36,8 @@ jobs: COMPOSE_PROJECT_NAME: ci-${{ github.job }}-${{ github.run_id }} steps: - uses: actions/checkout@v4 + with: + submodules: true - name: Build services run: docker compose build @@ -57,6 +61,8 @@ jobs: COMPOSE_PROJECT_NAME: ci-${{ github.job }}-${{ github.run_id }} steps: - uses: actions/checkout@v4 + with: + submodules: true - name: Build services run: docker compose build diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 7cc66ab..a58e67e 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -14,6 +14,7 @@ jobs: - uses: actions/checkout@v4 with: ref: ${{ github.sha }} + submodules: true - uses: docker/setup-buildx-action@v3 diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..47254a7 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "app/Assets/frontpage-assets"] + path = app/Assets/frontpage-assets + url = https://github.com/uklibraries/exploreuk-frontpage-assets diff --git a/Dockerfile b/Dockerfile index bee332b..49c59a7 100644 --- a/Dockerfile +++ b/Dockerfile @@ -101,6 +101,9 @@ COPY ./app ./app COPY ./public ./public COPY ./exe ./exe +RUN test -f public/shared/images/imls.png || \ + (echo "exploreuk-frontpage-assets submodule missing; check out with submodules" && exit 1) + COPY entrypoint.sh /usr/local/bin/entrypoint.sh RUN chmod +x /usr/local/bin/entrypoint.sh diff --git a/README.md b/README.md index 76e5def..dd58fe4 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,20 @@ Developer installations have been tested on Linux (through Windows with ### Quickstart ```shell -git clone https://github.com/uklibraries/findingaid.git +git clone --recurse-submodules https://github.com/uklibraries/findingaid.git cd findingaid make sample make dev ``` +Images shared between findingaid and +[exploreuk-web-app](https://github.com/uklibraries/exploreuk-web-app) come +from the +[exploreuk-frontpage-assets](https://github.com/uklibraries/exploreuk-frontpage-assets) +submodule at `app/Assets/frontpage-assets`, served through the `public/shared` +symlink. If you have cloned without `--recurse-submodules`, run +`git submodule update --init`. + The application should then be available at `http://localhost:8080/?id=`. Developers should run `make help` to see a list of helper commands through [make](https://www.gnu.org/software/make/). diff --git a/app/Assets/frontpage-assets b/app/Assets/frontpage-assets new file mode 160000 index 0000000..e150cc1 --- /dev/null +++ b/app/Assets/frontpage-assets @@ -0,0 +1 @@ +Subproject commit e150cc119c01bd9e08063122433c5a9bd8eb25ac diff --git a/app/Views/Euk_Shared/global-footer.mustache b/app/Views/Euk_Shared/global-footer.mustache index f5a99ef..c1b72b2 100644 --- a/app/Views/Euk_Shared/global-footer.mustache +++ b/app/Views/Euk_Shared/global-footer.mustache @@ -78,7 +78,7 @@
- Federal Depository Library + Federal Depository Library
diff --git a/app/Views/Euk_Shared/sponsors.mustache b/app/Views/Euk_Shared/sponsors.mustache index 2d0fd8c..8fff474 100644 --- a/app/Views/Euk_Shared/sponsors.mustache +++ b/app/Views/Euk_Shared/sponsors.mustache @@ -8,19 +8,19 @@ diff --git a/public/shared b/public/shared new file mode 120000 index 0000000..026c9bc --- /dev/null +++ b/public/shared @@ -0,0 +1 @@ +../app/Assets/frontpage-assets/shared \ No newline at end of file