https://github.com/snollygolly/operation-storefront
:scream: An experiment in immersive horror through web technologies.
https://github.com/snollygolly/operation-storefront
couchdb horror interactive-storytelling koa twilio
Last synced: about 2 months ago
JSON representation
:scream: An experiment in immersive horror through web technologies.
- Host: GitHub
- URL: https://github.com/snollygolly/operation-storefront
- Owner: snollygolly
- Created: 2016-08-19T01:03:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-02-23T23:03:44.000Z (over 5 years ago)
- Last Synced: 2025-03-31T08:43:22.232Z (3 months ago)
- Topics: couchdb, horror, interactive-storytelling, koa, twilio
- Language: JavaScript
- Homepage:
- Size: 1.11 MB
- Stars: 12
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Operation Storefront
This project was part of an immersive horror experience posted on [/r/nosleep](https://www.reddit.com/r/nosleep/). For more information about this project, please check out the [writeup.md](https://github.com/snollygolly/operation-storefront/blob/master/writeup.md).
## Prerequisites
* [Node.js](https://nodejs.org/en/) (Version 5 and up recommended)
* [Github Client ID and Secret](https://github.com/settings/developers) (for OAuth)
* [CouchDB](http://couchdb.apache.org/)
### Setup
The following databases need to be made in CouchDB
* subjects (for storing information about subjects)
* messages (for storing information from the contact form)
* answers (for storing stats about questions)
We also have a view that we run that looks like this:
```
function(doc) {
key = doc.stage
emit(key, {token: doc.token, phone: doc.phone});
}
```
It's saved as `_design/listings/stage`
### Installation
* Clone down the repository.
```
git clone https://github.com/snollygolly/operation-storefront.git
```
* Install packages (from inside the operation-storefront folder).
```
npm install
```
* Create your config. There's a `config.json.example` file in the root. Edit it to include all your values for the site and your OAuth information. Save it as `config.json` and leave it in the root.
* If you want to use Google Analytics, set `config.site.analytics` to your Tracking ID and make sure the analytics partial (analytics.hbs) contains the correct Universal Analytics tracking code. If you don't want to use Google Analytics, remove that property or set it to false.
* Start it up.
```
npm start
```
* Enjoy!