https://github.com/canopy-iiif/canopy-iiif
a IIIF Collection sourced site generator in Next.js for digital collections, humanities, and exhibitions
https://github.com/canopy-iiif/canopy-iiif
iiif iiif-presentation next-js
Last synced: 7 months ago
JSON representation
a IIIF Collection sourced site generator in Next.js for digital collections, humanities, and exhibitions
- Host: GitHub
- URL: https://github.com/canopy-iiif/canopy-iiif
- Owner: canopy-iiif
- License: mit
- Created: 2021-11-19T05:16:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T17:54:15.000Z (about 1 year ago)
- Last Synced: 2025-05-07T07:19:22.566Z (about 1 year ago)
- Topics: iiif, iiif-presentation, next-js
- Language: TypeScript
- Homepage: https://canopy-iiif.github.io/docs/
- Size: 16.2 MB
- Stars: 47
- Watchers: 1
- Forks: 16
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
[](https://stackblitz.com/fork/github/canopy-iiif/canopy-iiif)
- [Demo (Static)](https://canopy-iiif.github.io/canopy-iiif/)
- [Demo (Vercel SSR)](https://canopy-iiif.vercel.app/)
- [Documentation](https://canopy-iiif.github.io/docs/)
## 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.