Skip to content

Latest commit

 

History

History
175 lines (120 loc) · 8.3 KB

README.md

File metadata and controls

175 lines (120 loc) · 8.3 KB
Raw

Project #2: Oracle of Changes

Live Version

Oracle of Changes on Heroku

Getting Started

Prerequisites

It is assumed you have Node.js and Yarn installed.

Clone this project to a local machine or server. Then install the node modules:

yarn install

Sign in with Twitter

For sign in with Twitter to work via passport-twitter node package:

  1. Register an application with Twitter at Twitter Application Management to receive a consumer key (API Key) and a consumer secret (API Secret).
  2. Provide the actual callback URL to Twitter.
  3. Lastly, add these to config/config.js.

MongoDB

Add the URL of your database to config/config.js.

How to Use the Oracle of Changes

  1. Sign up for a local account, or sign up with Twitter. You will be signed in after successfully creating an account or authentication with Twitter.
  2. Press Consult on the navigation bar to head to the Yarrow Stalk Oracle.

  1. Type in your query, then press Start.
  2. Follow your instinct and click on the gap between the stalks to split it.

  1. Three splits are needed to obtain a line, and six lines are needed to form a hexagram.

  1. Once completed, press Submit to receive full divination result, complete with the relevant text from the Book of Changes and the Forest of Changes, supplemented with English translation whenever available.

The sorting into fours and taking out of remainders after each split is automatically taken care of. The raw divination data is captured in the table, with every line obtained shown in the last column.

Built With

Technologies

Node Packages

  • bcrypt
  • body-parser
  • connect-flash
  • cookie-parser
  • express
  • express-handlebars
  • express-session
  • express-validator
  • mongoose
  • passport
  • passport-local
  • passport-twitter
  • connect-mongo

CSS Framework

CSS/JS plugin

Workflow

Use Cases

Entity Relationship Diagram

Wireframes

Landing page

The navigation bar slides up and hides itself when the page is scrolled up. It will slide down to reveal itself again when the page is scrolled down.

Sign in modal

Sign up modal

Consult Oracle page

Desktop and laptop users can hover their mouse cursors over the yarrow stalks and the gap will follow the cursor. The mouse cursor will change from the default arrow to a gloved hand pointer when it is over a gap. Upon reaching the desired spot, simply click on the gap to split the yarrow stalks. Clicking on the stalks will not trigger any split.

The slider bar below the yarrow stalks is primarily intended for smartphone and tablet users as they will not be able to hover over the stalk and precisely choose where the spilt the stalks. With the slider bar, smartphone and tablet users will be able to split the stalk with the same precision as desktop and laptop users.

The yarrow stalks will resize to fit the width on smaller screens.

Navigation Bar Burger and Menu for Smaller Viewports

Display of divination result and individual past record

User Stories

As a casual user of the Oracle of Changes, I

  • want to try the traditional yarrow stalk oracle without having to follow complicated instructions and physical equipment.
  • want to try the yarrow stalk oracle without having to create an account
  • do not want to be bogged down by the repetitive, lengthly, and mistakes prone procedure of the yarrow stalk oracle.

As a serious/committed user of the Oracle of Changes, I

  • want to regularly consult the traditional yarrow stalk oracle without the hefty time commitment (typically 20 to 30 minutes to obtain a hexagram).
  • want the divination result to be automatically generated from the hexagram obtained from the oracle
  • want to conveniently refer to reliable sources for divination texts.
  • want reliable Chinese-English correspondence of divination texts at my fingertips.
  • want a clean, streamlined experience stripped of all the kitsch and clichéd design commonly associated with all things fortune-telling and Chinese.

Acknowledgments

  • Chinese Text Project API for providing the texts of the Book of Changes and Forest of Changes
  • Bulma.io, apart from providing the CSS framework, for making possible the following JavaScript interactivity:
    • Navigation burger button toggle and animation effect:
      • Burger button toggles to close ✕ button and vice versa.
    • Navigation burger menu dropdown effect,
    • Navigation bar scrolling effects, including:
      • Slide up to conceal while scrolling down the page,
      • Slide down to reveal while scrolling up the page, and
      • Cast shadow when it is visible and fade out when top is reached
    • Modal toggle
  • Russell W. Cottrell, M.D. for his innovative Virtual Yarrow Stalks.
    • Instead of the coin toss method or relying on a random number generator, Dr. Cottrell's Virtual Yarrow Stalks features a brilliant workaround by simply laying the yarrow stalks in a neat row across the screen with an inserted gap to simulate the split.
    • I believe this is the best possible virtual counterpart to the physical spliting of yarrow stalks by hand. Dr. Cottrell's Virtual Yarrow Stalks substantially replicates the traditional yarrow stalk method by intelligently adapting to the constraints of the new medium.
    • Additionally, unlike the coin toss method, this allows the uneven probabilities (6.25%, 31.25%, 43.75%, 18.75% respectively) of obtaining lines 6, 7, 8, and 9 to be retained.