https://github.com/wragge/trove-lists-exhibition-demo

https://github.com/wragge/trove-lists-exhibition-demo

Last synced: 8 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wragge/trove-lists-exhibition-demo
• Owner: wragge
• Created: 2015-12-12T13:05:48.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-12T13:37:10.000Z (about 9 years ago)
• Last Synced: 2024-11-13T11:16:31.395Z (2 months ago)
• Language: CSS
• Size: 822 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Trove Lists Exhibition

This is a AngularJS web app that retrieves lists of resources collected in Trove Lists via the Trove API, and then displays them as a simple exhibition.

You can easily customise it to turn your own collection of lists into an exhibition.

See the [demo](http://keepsakes-lists-demo.herokuapp.com/#/).

## Setting things up.

Clone this repository into the folder of your choice.

Run the following to install the bits you need:

```

npm install

bower install

```

## Customising your exhibition

First get a Trove API key.

Open `index.html` in the editor of your choice.

Look for the 'EDIT THIS SECTION TO ADD YOUR EXHIBITION DETAILS' section.

Modify this to add your own exhibition name, tagline and description. Most importantly, edit the list of lists to include your own.

Insert your API key where you see `var troveAPIKey = "";`

## Generating your exhibition.

To view your exhibition locally:

```

grunt serve

````

To build your exhibition for publication:

```

grunt build

```

Once the build process is complete, your exhibition will be available in the `dist` directory. Just copy the contents of this directory to the webhost of your choice.