beefoo / culturecraft

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CultureCraft

Paint with open culture

CultureCraft is like a simple painting program, but instead of painting with colors, you are painting with fragments of visual culture from renowned museums and libraries such as the Met, the Smithsonian, and the New York Public Library.

Run locally

This is a simple static web app that can be run locally using NodeJS like:

git clone https://github.com/beefoo/culturecraft.git
cd culturecraft
npm install
npm run

Using your own image collections

  1. Place your images in ./ingest/images/.
  2. Edit config.json, specifically the collections key with metadata about your collections
  3. Update metadata.csv with your images' metadata.
    • You'll need at least fields: index, id, title, url, source, and filename
    • index is a sequential integer starting at zero, which will be used to enforce item order
    • id must be unique
    • source must match the collection id as defined in config.json
    • filename must match the image's filename in ./ingest/images/
  4. If you haven't already, run npm install
  5. Run npm run ingest which will generate image thumbnails and json in the app directory
  6. Run npm run credits which will update the ./site/index.html and ./site/credits.html with collection and item metadata.
  7. View the app locally by running npm start

About

License:MIT License


Languages

Language:HTML 71.8%Language:JavaScript 22.9%Language:CSS 5.3%