adildsw / surve-a-story

:scroll: Surve-a-Story is a server-based customizable survey/form application capable of serving interactive stories and puzzles.

Surve-a-Story

📜 Surve-a-Story is a server-based customizable survey/form application capable of serving interactive stories and puzzles.

Getting Started

The following instructions will help you get this system up and running in your local system.

Prerequisite

Before proceeding to the installation, make sure that your system contains Node.js.

Install Node.js

Compiling Source

Once all the prerequisites are installed, run the following commands on the terminal to compile the source code on your system:

1. Clone Source from GitHub

git clone https://github.com/adildsw/surve-a-story/

2. Install Project Dependencies

cd surve-a-story
npm install

Hosting the Server

If the source is compiled successfully without any errors, follow these steps to host the Node.js server:

Node.js Server

In a new terminal, navigate to surve-a-story folder. Then run the following command:

node app.js

Upon successful Node.js server hosting, the terminal should return the following message:

 Server Running at Port 8888

Launching the System

Once the server is hosted and running, open your browser and navigate to http://localhost:8888/. Enjoy!

Crafting a Custom Escape Room

This involves modifying the story.json file. More details on the templating system will be updated soon.

surve-a-story's Issues

Sequence should be automatically determined by the object keys if none is provided

Using the request.body.itemCode cannot be trusted

in app.js the var itemCode = request.body.itemCode is never verified that it matches the current storyIdx.

Therefor, two tabs can be used to skip questions without the correct answer.

For example:
Tab 1: Navigate to question 1.
Tab 2: Navigates normally to question 3.
Tab 1: Answer question 1, but it moves user to question 4

Suggested fix

Test before incrementing storyIdx
Like so:

          if(itemCode == story["sequence"][sess.storyIdx])
               sess.storyIdx++