Skip to content
This repository has been archived by the owner on Jun 6, 2022. It is now read-only.

Latest commit

 

History

History
51 lines (36 loc) · 1.92 KB

README.md

File metadata and controls

51 lines (36 loc) · 1.92 KB

mixtape hunt

mixtape hunt is a Node.js web app for providing a collaborative unlockable scavenger hunt. Users unlock individual pieces of media by browsing to unique URLs and can see what pieces of media have been unlocked by other users.

dependancies Known Vulnerabilities

Originally created as Press Play NYC, a mixtape scavenger hunt for Youtube song tracks around Manhattan, mixtape hunt has been refactored to suite any purpose and will continue to expand in customization and support.

Installation

  1. First make sure to have Node.js installed.
  2. Next clone the repo.
  3. After you've cloned the repo be sure to install the correct modules
	npm install

Next onto configuration!

Configuration

mixtape hunt uses Node-config, visit their site for indepth understanding of config file usage.

At minimum the repo includes an example configuration file in config/ named default.template.json. You can use that as a guideline and make a copy named default.json and the app will load it up.

TODO: explain basic configuration

Usage

To start the app run node with index.js:

node index.js

TODO: explain basic usage

Credits

Created by Trish Ang (@feesh) and Ian Grossberg (@yoiang) in collaboration with Bernice Au.

Built on:

  • JQuery
  • Bootstrap
  • GifLinks
  • noodle

Cassette icon designed by mathies janssen from the Noun Project