Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glenrobson/pba
Canopy project for the P B Abery Collection
https://github.com/glenrobson/pba
Last synced: about 1 month ago
JSON representation
Canopy project for the P B Abery Collection
- Host: GitHub
- URL: https://github.com/glenrobson/pba
- Owner: glenrobson
- License: mit
- Created: 2023-12-06T19:01:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-06T19:11:46.000Z (about 1 year ago)
- Last Synced: 2023-12-06T20:24:21.165Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://glenrobson.github.io/pba/
- Size: 4.08 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Canopy IIIF
A purely IIIF sourced static site generator using Next.js. Canopy is an application that will build a browseable and searchable digital collections style static site entirely from a IIIF Collection and the items it contains.
[](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/)
## 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.