Merge pull request #126 from samvera-labs/suite

v2.0.0 - "Clover as a Suite"

.github/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to Clover IIIF
+
+## Questions
+
+If you have questions about Clover IIIF, be sure to check out the docs where we have several examples and detailed API references that may help you solve your problem.
+
+## How to contribute
+
+There are many ways to contribute to the project. Code is just one possible means of contribution.
+
+- **Feedback.** Tell us what we're doing well or where we can improve.
+- **Support.** Please reach out to `@mat` or `@adam.arling` in the [IIIF Slack workspace](iiif.slack.com) or submit a new issue in [open issues](https://github.com/samvera-labs/clover-iiif/issues).
+- **Write.** If you come up with an interesting example, write about it. Post it to your blog and share it with us. We'd love to see what folks in the community build with Clover IIIF!
+- **Report.** Create issues with bug reports so we can make Clover IIIF even better.
+
+## Working on your first Pull Request?
+
+There are a lot of great resources on creating a good pull request. We've included a few below, but don't be shy—we appreciate all contriibutions and are happy to help those who are willing to help us!
+
+- [How to Contribute to a Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
+
+## Preparing a Pull Request
+
+[Pull Requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) are always welcome, but before working on a large change, it is best to open an issue first to discuss it with maintainers.
+
+A good PR is small, focuses on a single feature or improvement, and clearly communicates the problem it solves. Try not to include more than one issue in a single PR. It's much easier for us to review multiple small pull requests than one that is large and unwieldy.
+
+1. [Fork the repository](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo).
+
+2. Clone the fork to your local machine and add upstream remote:
+
+```sh
+git clone https://github.com/<your username>/clover-iiif.git
+cd clover-iiif
+git remote add upstream https://github.com/samvera-labs/clover-iiif.git
+```
+
+1. Synchronize your local `main` branch with the upstream remote:
+
+```sh
+git checkout main
+git pull upstream main
+```
+
+1. Make sure your Node version matches the [.nvmrc](../.nvmrc).
+
+```
+node -v
+```
+
+1. Install dependencies with [yarn](https://yarnpkg.com):
+
+```sh
+npm run install
+```
+
+1. Create a new branch related to your PR:
+
+```sh
+git checkout -b my-bug-fix
+```
+
+6. Make changes, then commit and push to your forked repository:
+
+```sh
+git push -u origin HEAD
+```
+
+7. Go to [the repository](https://github.com/samvera/clover-iiif) and [make a Pull Request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+
+8. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation.
+
+## Working locally
+
+The repo is managed with Yarn Workspaces.
+
+### Development
+
+```bash
+# install dependencies
+npm run install
+
+# start Nextra-based docs and see examples in the browser
+npm run dev
+```
+
+Make your changes and check that they resolve the problem with an example in the docs. We also suggest adding tests to support your change, and then run `npm run test` to make sure nothing is broken.
+
+Lastly, run `npm run build` to ensure that the build runs successfully before submitting the pull request.

.github/workflows/gh-pages.deploy.yml

@@ -1,4 +1,4 @@
-name: Deploy to GitHub Pages
+name: Deploy Documentation
 
 on:
   push:
@@ -9,27 +9,31 @@ jobs:
     runs-on: ubuntu-latest
 
     env:
-      NEXT_PUBLIC_BASE_PATH: /clover-iiif
-
-    strategy:
-      matrix:
-        node-version: [14.x]
+      NEXT_PUBLIC_BASE_PATH: /clover-iiif-proto
 
     steps:
-      - name: Get files
-        uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+      - name: Cancel Previous Runs
+        uses: styfle/[email protected]
+
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node-version }}
-      - name: Install packages
+          node-version: 18.x
+
+      - name: Install
         run: npm ci
-      - name: Export static files
-        run: npm run build:static
-      - name: Add .nojekyll file
-        run: touch ./static/.nojekyll
+
+      - name: Build
+        run: npm run build:docs
+
+      - name: Bypass Jekyll
+        run: touch ./out/.nojekyll
+
       - name: Deploy
-        uses: JamesIves/github-pages-deploy-action@4.1.1
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
           branch: gh-pages
-          folder: static
+          folder: out

.github/workflows/run-tests.yml

@@ -0,0 +1,36 @@
+name: Run Tests
+
+on:
+  pull_request:
+    branches: [suite]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    env:
+      NEXT_PUBLIC_BASE_PATH: /clover-iiif-proto
+
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/[email protected]
+
+      - name: Get files
+        uses: actions/checkout@v3
+
+      - name: Setup PNPM
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Setup NodeJS
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+          cache: "pnpm"
+
+      - name: Install packages
+        run: pnpm install
+
+      - name: Run tests
+        run: pnpm test

.gitignore

@@ -1,10 +1,14 @@
 # dev
+.build
+.next
 dist
 node_modules
+out
 public/script.js
 public/script.js.map
 public/index.html
-static
+coverage/
+html/
 
 # OS
 .DS_Store

LICENSE

@@ -1,21 +1,3 @@
 MIT License
 
-Copyright (c) 2022 Northwestern University Libraries
-
-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.
+Copyright (c) 2023 Mat Jordan, Adam Arling