diff --git a/.babelrc b/.babelrc new file mode 100644 index 0000000..ae36a5e --- /dev/null +++ b/.babelrc @@ -0,0 +1,4 @@ +{ + "presets": ["next/babel", "@babel/preset-typescript"], + "plugins": [] +} diff --git a/.env b/.env new file mode 100644 index 0000000..b4ae148 --- /dev/null +++ b/.env @@ -0,0 +1,2 @@ +NEXT_PUBLIC_URL="https://canopy-iiif.github.io" +NEXT_PUBLIC_BASE_PATH="/canopy-iiif" \ No newline at end of file diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..04e763f --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,28 @@ +{ + "plugins": ["@typescript-eslint", "testing-library"], + "extends": [ + "plugin:@typescript-eslint/recommended", + "next", + "next/core-web-vitals", + "prettier" + ], + "overrides": [ + // Only uses Testing Library lint rules in test files + { + "files": [ + "**/__tests__/**/*.[jt]s?(x)", + "**/?(*.)+(spec|test).[jt]s?(x)" + ], + "extends": ["plugin:testing-library/react"] + } + ], + "rules": { + // "sort-keys": "error", + // "sort-imports": "error", + "@typescript-eslint/no-var-requires": "off", + "@typescript-eslint/no-unused-vars": "error", + "@typescript-eslint/no-explicit-any": "off", + "@typescript-eslint/sort-type-union-intersection-members": "error", + "@typescript-eslint/ban-ts-comment": "off" + } +} diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..4ac104c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,27 @@ +--- +name: Bug +about: Report an issue +title: '' +labels: bug +assignees: '' + +--- + +**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. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-enhancement.md b/.github/ISSUE_TEMPLATE/feature-enhancement.md new file mode 100644 index 0000000..c57d228 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-enhancement.md @@ -0,0 +1,14 @@ +--- +name: Feature/Enhancement +about: New feature or enhancement +title: '' +labels: enhancement +assignees: '' + +--- + +## Description + +## Done Looks Like +- [ ] to do 1 +- [ ] to do 2 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..90442f6 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +# What does this do? + +_Please include a summary of the changes and the related issue. Please also include relevant motivation and context._ + +## What type of change is this? + +- [ ] 🐛 **Bug fix** (non-breaking change addressing an issue) +- [ ] ✨ **New feature or enhancement** (non-breaking change which adds functionality) +- [ ] 🧨 **Breaking change** (fix or feature that would cause existing functionality to not work as expected) +- [ ] 🚧 **Maintenance or refinement of codebase structur**e (ex: dependency updates) +- [ ] 📘 **Documentation update** + +## Additional Notes + +_Please include any extra notes here._ diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..62c0b86 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,29 @@ +name: Test IIIF Collection Build +on: push +jobs: + test-build: + runs-on: ubuntu-latest + # Only run if the repository is canopy-iiif/canopy-iiif + if: github.repository == 'canopy-iiif/canopy-iiif' + steps: + - uses: actions/checkout@v2 + - name: Install dependencies + run: npm install + - name: Unit testing + run: npm run test:ci + - name: 2.x Collection (Aggregation) + run: npm run prebuild -- --path=./config/.fixtures/canopy.presentation-2.json + - name: 2.x Collection (Build) + run: npm run test-build + - name: 3.0 Collection (Aggregation) + run: npm run prebuild -- --path=./config/.fixtures/canopy.presentation-3.json + - name: 3.0 Collection (Build) + run: npm run test-build + - name: Customize Search (Aggregation) + run: npm run prebuild -- --path=./config/.fixtures/canopy.customize-search.json + - name: Customize Search (Build) + run: npm run test-build + - name: Minimal Configuration (Aggregation) + run: npm run prebuild -- --path=./config/.fixtures/canopy.minimal.json + - name: Minimal Configuration (Build) + run: npm run test-build diff --git a/.github/workflows/gh-pages.deploy.yml b/.github/workflows/gh-pages.deploy.yml new file mode 100644 index 0000000..ccf8a78 --- /dev/null +++ b/.github/workflows/gh-pages.deploy.yml @@ -0,0 +1,43 @@ +name: Deploy to GitHub Pages + +on: + push: + branches: [main] + +jobs: + build: + runs-on: ubuntu-latest + + strategy: + matrix: + node-version: [18.x] + + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Setup Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + + - name: Load NEXT_PUBLIC_URL and NEXT_PUBLIC_BASE_PATH from .env + run: | + set -o allexport + source .env + set +o allexport + + - name: Install + run: npm ci + + - name: Build + run: npm run build:static + + - name: Bypass Jekyll + run: touch ./out/.nojekyll + + - name: Deploy + uses: JamesIves/github-pages-deploy-action@v4 + with: + branch: gh-pages + folder: out diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7205ab1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,41 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# local env files +.env.local +.env.development.local +.env.test.local +.env.production.local + +# vercel +.vercel + +.canopy +.vscode + +public/api +public/robots.txt +public/sitemap* \ No newline at end of file diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 0000000..e69de29 diff --git a/.stackblitzrc b/.stackblitzrc new file mode 100644 index 0000000..d98146f --- /dev/null +++ b/.stackblitzrc @@ -0,0 +1,4 @@ +{ + "installDependencies": true, + "startCommand": "npm run dev" +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..aaeadbc --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Mat Jordan + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d0ef0bd --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# Canopy IIIF + +An open-source static site generator designed for fast creation, contextualization, and customization of a discovery-focused digital scholarship and collections website using [IIIF](https://iiif.io/) APIs. + +[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/canopy-iiif/canopy-iiif) + +- [Demo (Static)](https://canopy-iiif.github.io/canopy-iiif/) +- [Demo (Vercel)](https://canopy-iiif.vercel.app/) +- [Documentation](https://canopy-iiif.github.io/docs/) + +![collage of canopy iiif views](https://github.com/canopy-iiif/canopy-iiif/assets/7376450/1779a0ce-1f62-4e9b-8186-110264c81bba) + +## Setup + +### Install Dependencies + +```shell +# installation +npm i +``` + +### Running in Development + +```shell +# development +npm run dev +``` + +### Building in Production + +```shell +# build +npm run build +``` + +## Tests + +To run Jest unit tests: + +```shell +npm run test +``` + +## Configuration + +Canopy IIIF uses a default configuration `config/.default/canopy.default.json` for demonstration purposes if a custom one is not set. The build process will read from a custom configuration file at `config/canopy.json` if it exists. See the [Create a Canopy Project guide](https://canopy-iiif.github.io/docs/get-started) for detailed step-by-step instructions. + +## License + +This project is [licensed](https://github.com/canopy-iiif/canopy-iiif/blob/main/LICENSE) under the MIT License. diff --git a/canopy.ts b/canopy.ts new file mode 100644 index 0000000..48da09d --- /dev/null +++ b/canopy.ts @@ -0,0 +1,32 @@ +require("dotenv").config(); +const buildConfig = require("./src/lib/build/config"); +const aggregate = require("./src/lib/build/aggregate"); + +const args = process.argv; + +(() => { + const path = args + .find((value) => value.includes("--path=")) + ?.split("=") + ?.pop(); + + const isDev = args.includes("dev"); + const config = buildConfig.getConfig(path, isDev); + + const url = isDev ? `http://localhost:5001` : process.env.NEXT_PUBLIC_URL; + const basePath = isDev ? `` : process.env.NEXT_PUBLIC_BASE_PATH; + const baseUrl = basePath ? `${url}${basePath}` : url; + const assetPrefix = basePath; + + const env = { + CANOPY_CONFIG: { + ...config, + url, + assetPrefix, + basePath, + baseUrl, + }, + }; + + aggregate.build(env.CANOPY_CONFIG); +})(); diff --git a/config/.default/canopy.default.json b/config/.default/canopy.default.json new file mode 100644 index 0000000..b182c31 --- /dev/null +++ b/config/.default/canopy.default.json @@ -0,0 +1,72 @@ +{ + "collection": "https://api.dc.library.northwestern.edu/api/v2/search?query=%22nez%20perce%22&as=iiif&size=125", + "metadata": ["Subject", "Date", "Dimensions"], + "featured": [ + "https://api.dc.library.northwestern.edu/api/v2/works/cd5e1b9c-370b-40e5-b3d9-defc1d8e0777?as=iiif", + "https://api.dc.library.northwestern.edu/api/v2/works/14a6aa15-9e12-47a7-9617-91f430d4f47b?as=iiif" + ], + "locales": [ + { + "config": "locales/en.json", + "label": "English", + "lang": "en" + } + ], + "map": { + "defaultBounds": [[51.505, -0.09]], + "enabled": false, + "icon": { + "iconUrl": "images/marker-icon.png", + "iconSize": [24, 36], + "iconAnchor": [12, 36] + }, + "tileLayers": [ + { + "name": "OpenStreetMap", + "url": "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png", + "attribution": "© OpenStreetMap contributors" + } + ] + }, + "search": { + "enabled": true, + "flexSearch": { + "charset": "latin:extra", + "optimize": true, + "tokenize": "strict", + "bidirectional": false, + "document": { + "index": [ + { + "field": "label", + "tokenize": "full", + "resolution": 9, + "depth": 3, + "bidirectional": true + }, + { + "field": "metadata", + "resolution": 2 + }, + { + "field": "summary", + "resolution": 1 + } + ] + } + }, + "index": { + "metadata": { + "enabled": true, + "all": false + }, + "summary": { + "enabled": false + } + } + }, + "theme": { + "defaultTheme": "light", + "toggleEnabled": false + } +} diff --git a/config/.fixtures/canopy.customize-search.json b/config/.fixtures/canopy.customize-search.json new file mode 100644 index 0000000..d24d535 --- /dev/null +++ b/config/.fixtures/canopy.customize-search.json @@ -0,0 +1,44 @@ +{ + "collection": "https://api.dc.library.northwestern.edu/api/v2/collections/c373ecd2-2c45-45f2-9f9e-52dc244870bd?as=iiif", + "featured": [ + "https://api.dc.library.northwestern.edu/api/v2/works/2de0355c-8e48-4478-93af-8cbd1437bd16?as=iiif" + ], + "metadata": ["Date", "Subject"], + "search": { + "enabled": true, + "flexSearch": { + "charset": ["latin:extra"], + "optimize": true, + "tokenize": "strict", + "bidirectional": false, + "document": { + "index": [ + { + "field": "label", + "tokenize": "full", + "resolution": 9, + "depth": 3, + "bidirectional": true + }, + { + "field": "metadata", + "resolution": 2 + }, + { + "field": "summary", + "resolution": 1 + } + ] + } + }, + "index": { + "metadata": { + "enabled": true, + "all": true + }, + "summary": { + "enabled": true + } + } + } +} diff --git a/config/.fixtures/canopy.dev-collection.json b/config/.fixtures/canopy.dev-collection.json new file mode 100644 index 0000000..1ee1559 --- /dev/null +++ b/config/.fixtures/canopy.dev-collection.json @@ -0,0 +1,4 @@ +{ + "collection": "https://api.dc.library.northwestern.edu/api/v2/collections/c373ecd2-2c45-45f2-9f9e-52dc244870bd?as=iiif", + "devCollection": "https://api.dc.library.northwestern.edu/api/v2/collections/c373ecd2-2c45-45f2-9f9e-52dc244870bd?as=iiif&size=5" +} diff --git a/config/.fixtures/canopy.minimal.json b/config/.fixtures/canopy.minimal.json new file mode 100644 index 0000000..f59689e --- /dev/null +++ b/config/.fixtures/canopy.minimal.json @@ -0,0 +1,3 @@ +{ + "collection": "https://api.dc.library.northwestern.edu/api/v2/collections/c373ecd2-2c45-45f2-9f9e-52dc244870bd?as=iiif" +} diff --git a/config/.fixtures/canopy.presentation-2.json b/config/.fixtures/canopy.presentation-2.json new file mode 100644 index 0000000..0c515f4 --- /dev/null +++ b/config/.fixtures/canopy.presentation-2.json @@ -0,0 +1,8 @@ +{ + "collection": "https://iiif.bodleian.ox.ac.uk/iiif/collection/hobhouse", + "featured": [ + "https://iiif.bodleian.ox.ac.uk/iiif/manifest/8da97e8c-4e12-457d-aad8-3327b3aec183.json", + "https://iiif.bodleian.ox.ac.uk/iiif/manifest/2968d5c7-3718-44ef-92ea-ee4cc58cc677.json" + ], + "metadata": ["Extent", "Date Statement"] +} diff --git a/config/.fixtures/canopy.presentation-3.json b/config/.fixtures/canopy.presentation-3.json new file mode 100644 index 0000000..4a0e825 --- /dev/null +++ b/config/.fixtures/canopy.presentation-3.json @@ -0,0 +1,7 @@ +{ + "collection": "https://api.dc.library.northwestern.edu/api/v2/collections/c373ecd2-2c45-45f2-9f9e-52dc244870bd?as=iiif", + "featured": [ + "https://api.dc.library.northwestern.edu/api/v2/works/2de0355c-8e48-4478-93af-8cbd1437bd16?as=iiif" + ], + "metadata": ["Date", "Subject", "Genre", "Dimensions"] +} diff --git a/config/canopy.sample.json b/config/canopy.sample.json new file mode 100644 index 0000000..1b514b6 --- /dev/null +++ b/config/canopy.sample.json @@ -0,0 +1,13 @@ +{ + "collection": "https://example.org/iiif/collection.json", + "devCollection": "https://example.org/iiif/collection-small-sample.json", + "featured": [ + "https://example.org/manifest-1.json", + "https://example.org/manifest-2.json" + ], + "metadata": ["Date", "Subject"], + "label": { "none": ["Collection Title"] }, + "summary": { + "none": ["Brief description of the site and its contents."] + } +} diff --git a/config/locales/en.json b/config/locales/en.json new file mode 100644 index 0000000..154f93c --- /dev/null +++ b/config/locales/en.json @@ -0,0 +1,12 @@ +{ + "footerSourceCollection": "Source Collection", + "footerToggleTheme": "Toggle Theme", + "homepageHighlightedWorks": "Highlighted Works", + "searchButton": "Search", + "searchResults": "Results", + "searchFilter": "Filter", + "searchFilterAny": "Any", + "searchFilterClear": "Clear All", + "searchFilterClose": "Close", + "searchFilterSubmit": "View Results" +} diff --git a/config/locales/fr.json b/config/locales/fr.json new file mode 100644 index 0000000..4db2e92 --- /dev/null +++ b/config/locales/fr.json @@ -0,0 +1,12 @@ +{ + "footerSourceCollection": "Collection source", + "footerToggleTheme": "Changer le thème", + "homepageHighlightedWorks": "Contenus mis en évidence", + "searchButton": "Rechercher", + "searchResults": "Résultats", + "searchFilter": "Filtrer", + "searchFilterAny": "Tout", + "searchFilterClear": "Effacer tout", + "searchFilterClose": "Fermer", + "searchFilterSubmit": "Voir les résultats" +} diff --git a/config/locales/nb.json b/config/locales/nb.json new file mode 100644 index 0000000..c11bc93 --- /dev/null +++ b/config/locales/nb.json @@ -0,0 +1,12 @@ +{ + "footerSourceCollection": "Kildesamling", + "footerToggleTheme": "Skift tema", + "homepageHighlightedWorks": "Fremhevete verk", + "searchButton": "Søk", + "searchResults": "resultat", + "searchFilter": "Filter", + "searchFilterAny": "Alle", + "searchFilterClear": "Fjern filter", + "searchFilterClose": "Lukk", + "searchFilterSubmit": "Se treff" +} \ No newline at end of file diff --git a/config/locales/nn.json b/config/locales/nn.json new file mode 100644 index 0000000..9ed88ee --- /dev/null +++ b/config/locales/nn.json @@ -0,0 +1,12 @@ +{ + "footerSourceCollection": "Kjeldesamling", + "footerToggleTheme": "Endre tema", + "homepageHighlightedWorks": "Framheva verk", + "searchButton": "Søk", + "searchResults": "resultat", + "searchFilter": "Filter", + "searchFilterAny": "Alle", + "searchFilterClear": "Fjern filter", + "searchFilterClose": "Lukk", + "searchFilterSubmit": "Sjå treffa" +} \ No newline at end of file diff --git a/config/locales/no.json b/config/locales/no.json new file mode 100644 index 0000000..c11bc93 --- /dev/null +++ b/config/locales/no.json @@ -0,0 +1,12 @@ +{ + "footerSourceCollection": "Kildesamling", + "footerToggleTheme": "Skift tema", + "homepageHighlightedWorks": "Fremhevete verk", + "searchButton": "Søk", + "searchResults": "resultat", + "searchFilter": "Filter", + "searchFilterAny": "Alle", + "searchFilterClear": "Fjern filter", + "searchFilterClose": "Lukk", + "searchFilterSubmit": "Se treff" +} \ No newline at end of file diff --git a/config/locales/pt.json b/config/locales/pt.json new file mode 100644 index 0000000..06c2e2d --- /dev/null +++ b/config/locales/pt.json @@ -0,0 +1,12 @@ +{ + "footerSourceCollection": "Coleção principal", + "footerToggleTheme": "Trocar tema", + "homepageHighlightedWorks": "Destaques", + "searchButton": "Buscar", + "searchResults": "Resultados", + "searchFilter": "Filtrar", + "searchFilterAny": "Todos", + "searchFilterClear": "Limpar tudo", + "searchFilterClose": "Fechar", + "searchFilterSubmit": "Ver resultados" +} diff --git a/content/404.mdx b/content/404.mdx new file mode 100644 index 0000000..76b7e6d --- /dev/null +++ b/content/404.mdx @@ -0,0 +1,7 @@ +--- +title: Page Not Found +--- + +# Page Not Found + +404 Error diff --git a/content/_meta.json b/content/_meta.json new file mode 100644 index 0000000..204a6d3 --- /dev/null +++ b/content/_meta.json @@ -0,0 +1,14 @@ +[ + { + "path": "/works", + "text": "Works" + }, + { + "path": "/metadata", + "text": "Metadata" + }, + { + "path": "/about", + "text": "About" + } +] diff --git a/content/about/_meta.json b/content/about/_meta.json new file mode 100644 index 0000000..6ac4b83 --- /dev/null +++ b/content/about/_meta.json @@ -0,0 +1,10 @@ +[ + { + "path": "/about", + "text": "About" + }, + { + "path": "/about/example", + "text": "Markdown Example" + } +] diff --git a/content/about/example.mdx b/content/about/example.mdx new file mode 100644 index 0000000..df47d8e --- /dev/null +++ b/content/about/example.mdx @@ -0,0 +1,126 @@ +--- +title: "Markdown Example" +description: Demonstration content with Markdown and Components using the MDX library +navigation: "about" +referencedManifests: + - "https://api.dc.library.northwestern.edu/api/v2/works/84aec8c1-42e8-4e2c-a6b2-1c7e3790217f?as=iiif" + - "https://api.dc.library.northwestern.edu/api/v2/works/cd5e1b9c-370b-40e5-b3d9-defc1d8e0777?as=iiif" + - "https://api.dc.library.northwestern.edu/api/v2/works/15871197-1616-4c37-9257-b0ad0dc5ab30?as=iiif" + - "https://api.dc.library.northwestern.edu/api/v2/works/14a6aa15-9e12-47a7-9617-91f430d4f47b?as=iiif" +--- + +# Markdown Example + +Canopy IIIF is designed to work with Markdown using the [MDX](https://mdxjs.com/) library. This allows you to use Canopy defined components in our Markdown content to easily extend IIIF resources. +This example page demonstrates some of components that are available for use reuse and remixing content in Markdown. + +This page is output from the `/content/about/example.mdx` file. + + + + + + + {navigation &&