From b0569f26640f0081b1f51d7ae02bbce356c91fb2 Mon Sep 17 00:00:00 2001
From: Ward Bell <wardbell@hotmail.com>
Date: Wed, 5 Jun 2013 19:08:43 -0700
Subject: [PATCH] Updated readme.md and removed the Web Storm gunk

---
 .gitignore                       |  4 ++
 .idea/.name                      |  1 -
 .idea/ZzaSampleDataGenerator.iml |  9 ----
 .idea/encodings.xml              |  5 ---
 .idea/misc.xml                   |  5 ---
 .idea/modules.xml                |  9 ----
 .idea/mongoSettings.xml          | 17 --------
 .idea/vcs.xml                    |  8 ----
 .idea/workspace.xml              | 72 +++++++++++++++++++++++--------
 README.md                        | 74 +++++++++++++++++++++++++++++++-
 index.html                       |  2 +-
 11 files changed, 130 insertions(+), 76 deletions(-)
 delete mode 100644 .idea/.name
 delete mode 100644 .idea/ZzaSampleDataGenerator.iml
 delete mode 100644 .idea/encodings.xml
 delete mode 100644 .idea/misc.xml
 delete mode 100644 .idea/modules.xml
 delete mode 100644 .idea/mongoSettings.xml
 delete mode 100644 .idea/vcs.xml

diff --git a/.gitignore b/.gitignore
index bdc3535..a03a071 100644
--- a/.gitignore
+++ b/.gitignore
@@ -99,8 +99,12 @@ ClientBin
 [Ss]tyle[Cc]op.*
 ~$*
 *.dbmdl
+Thumbs.db
 Generated_Code #added for RIA/Silverlight projects
 
+# Web Storm
+.idea
+
 # Backup & report files from converting an old project file to a newer
 # Visual Studio version. Backup files are not needed, because we have git ;-)
 _UpgradeReport_Files/
diff --git a/.idea/.name b/.idea/.name
deleted file mode 100644
index 1db4786..0000000
--- a/.idea/.name
+++ /dev/null
@@ -1 +0,0 @@
-ZzaSampleDataGenerator
\ No newline at end of file
diff --git a/.idea/ZzaSampleDataGenerator.iml b/.idea/ZzaSampleDataGenerator.iml
deleted file mode 100644
index 6b8184f..0000000
--- a/.idea/ZzaSampleDataGenerator.iml
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>
-
diff --git a/.idea/encodings.xml b/.idea/encodings.xml
deleted file mode 100644
index e206d70..0000000
--- a/.idea/encodings.xml
+++ /dev/null
@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="Encoding" useUTFGuessing="true" native2AsciiForPropertiesFiles="false" />
-</project>
-
diff --git a/.idea/misc.xml b/.idea/misc.xml
deleted file mode 100644
index 1162f43..0000000
--- a/.idea/misc.xml
+++ /dev/null
@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" />
-</project>
-
diff --git a/.idea/modules.xml b/.idea/modules.xml
deleted file mode 100644
index 0864557..0000000
--- a/.idea/modules.xml
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/ZzaSampleDataGenerator.iml" filepath="$PROJECT_DIR$/.idea/ZzaSampleDataGenerator.iml" />
-    </modules>
-  </component>
-</project>
-
diff --git a/.idea/mongoSettings.xml b/.idea/mongoSettings.xml
deleted file mode 100644
index 587e64f..0000000
--- a/.idea/mongoSettings.xml
+++ /dev/null
@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="MongoConfiguration">
-    <option name="serverConfigurations">
-      <list>
-        <ServerConfiguration>
-          <option name="label" value="Test" />
-          <option name="serverName" value="localhost" />
-          <option name="serverPort" value="27017" />
-          <option name="serverVersion" value="2.4.3" />
-        </ServerConfiguration>
-      </list>
-    </option>
-    <option name="shellPath" value="C:\mongo\mongodb\bin\mongo.exe" />
-  </component>
-</project>
-
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
deleted file mode 100644
index 9d32e50..0000000
--- a/.idea/vcs.xml
+++ /dev/null
@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="" />
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>
-
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 2c072e1..3c9c355 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -1,7 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="ChangeListManager">
-    <list default="true" id="19cb95ab-a6a0-442a-8882-3cb94c561ca1" name="Default" comment="" />
+    <list default="true" id="19cb95ab-a6a0-442a-8882-3cb94c561ca1" name="Default" comment="">
+      <change type="DELETED" beforePath="C:\Users\Ward\Documents\GitHub\zza.data\.idea\.name" afterPath="" />
+      <change type="DELETED" beforePath="C:\Users\Ward\Documents\GitHub\zza.data\.idea\ZzaSampleDataGenerator.iml" afterPath="" />
+      <change type="DELETED" beforePath="C:\Users\Ward\Documents\GitHub\zza.data\.idea\encodings.xml" afterPath="" />
+      <change type="DELETED" beforePath="C:\Users\Ward\Documents\GitHub\zza.data\.idea\misc.xml" afterPath="" />
+      <change type="DELETED" beforePath="C:\Users\Ward\Documents\GitHub\zza.data\.idea\modules.xml" afterPath="" />
+      <change type="DELETED" beforePath="C:\Users\Ward\Documents\GitHub\zza.data\.idea\mongoSettings.xml" afterPath="" />
+      <change type="DELETED" beforePath="C:\Users\Ward\Documents\GitHub\zza.data\.idea\scopes\scope_settings.xml" afterPath="" />
+      <change type="DELETED" beforePath="C:\Users\Ward\Documents\GitHub\zza.data\.idea\vcs.xml" afterPath="" />
+      <change type="DELETED" beforePath="C:\Users\Ward\Documents\GitHub\zza.data\.idea\workspace.xml" afterPath="" />
+      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/.gitignore" afterPath="$PROJECT_DIR$/.gitignore" />
+      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/README.md" afterPath="$PROJECT_DIR$/README.md" />
+      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/index.html" afterPath="$PROJECT_DIR$/index.html" />
+    </list>
     <ignored path="ZzaSampleDataGenerator.iws" />
     <ignored path=".idea/workspace.xml" />
     <file path="/ShortReferenceLists.js" changelist="19cb95ab-a6a0-442a-8882-3cb94c561ca1" time="1369648528542" ignored="false" />
@@ -26,7 +39,8 @@
     <file path="/fragment.js" changelist="19cb95ab-a6a0-442a-8882-3cb94c561ca1" time="1370256986139" ignored="false" />
     <file path="/a.dummy" changelist="19cb95ab-a6a0-442a-8882-3cb94c561ca1" time="1370468614420" ignored="false" />
     <file path="/startMongo.bat" changelist="19cb95ab-a6a0-442a-8882-3cb94c561ca1" time="1370478312055" ignored="false" />
-    <file path="/Dummy.txt" changelist="19cb95ab-a6a0-442a-8882-3cb94c561ca1" time="1370479475195" ignored="false" />
+    <file path="/Dummy.txt" changelist="19cb95ab-a6a0-442a-8882-3cb94c561ca1" time="1370480640236" ignored="false" />
+    <file path="/.gitignore" changelist="19cb95ab-a6a0-442a-8882-3cb94c561ca1" time="1370480754863" ignored="false" />
     <option name="TRACKING_ENABLED" value="true" />
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -63,7 +77,6 @@
   <component name="IdeDocumentHistory">
     <option name="changedFiles">
       <list>
-        <option value="$PROJECT_DIR$/Customer.js" />
         <option value="$PROJECT_DIR$/customer.js" />
         <option value="$PROJECT_DIR$/sqlReporter.js" />
         <option value="$PROJECT_DIR$/app.js" />
@@ -78,6 +91,7 @@
         <option value="$PROJECT_DIR$/startMongo.bat" />
         <option value="$PROJECT_DIR$/main.js" />
         <option value="$PROJECT_DIR$/output/ZzaDatabaseGen.sql" />
+        <option value="$PROJECT_DIR$/.gitignore" />
         <option value="$PROJECT_DIR$/index.html" />
       </list>
     </option>
@@ -114,7 +128,6 @@
       <sortByType />
     </navigator>
     <panes>
-      <pane id="Scope" />
       <pane id="ProjectPane">
         <subPane>
           <PATH>
@@ -133,22 +146,37 @@
               <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
             </PATH_ELEMENT>
           </PATH>
+          <PATH>
+            <PATH_ELEMENT>
+              <option name="myItemId" value="ZzaSampleDataGenerator" />
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.ProjectViewProjectNode" />
+            </PATH_ELEMENT>
+            <PATH_ELEMENT>
+              <option name="myItemId" value="zza.data" />
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
+            </PATH_ELEMENT>
+            <PATH_ELEMENT>
+              <option name="myItemId" value="output" />
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
+            </PATH_ELEMENT>
+          </PATH>
         </subPane>
       </pane>
+      <pane id="Scope" />
     </panes>
   </component>
   <component name="PropertiesComponent">
     <property name="options.splitter.main.proportions" value="0.3" />
     <property name="WebServerToolWindowFactoryState" value="false" />
-    <property name="options.lastSelected" value="settings.github" />
     <property name="recentsLimit" value="5" />
-    <property name="restartRequiresConfirmation" value="true" />
+    <property name="options.lastSelected" value="settings.github" />
     <property name="last_opened_file_path" value="C:/mongo/mongodb/bin/mongod.exe" />
+    <property name="restartRequiresConfirmation" value="true" />
     <property name="FullScreen" value="false" />
     <property name="DefaultHtmlFileTemplate" value="Html5" />
-    <property name="GoToClass.includeJavaFiles" value="false" />
-    <property name="options.searchVisible" value="true" />
     <property name="options.splitter.details.proportions" value="0.2" />
+    <property name="options.searchVisible" value="true" />
+    <property name="GoToClass.includeJavaFiles" value="false" />
   </component>
   <component name="RecentsManager">
     <key name="MoveFile.RECENT_KEYS">
@@ -331,11 +359,6 @@
     </breakpoint-manager>
   </component>
   <component name="editorHistoryManager">
-    <entry file="file://$PROJECT_DIR$/product.js">
-      <provider selected="true" editor-type-id="text-editor">
-        <state line="90" column="83" selection-start="3910" selection-end="3910" vertical-scroll-proportion="0.0" />
-      </provider>
-    </entry>
     <entry file="file://$PROJECT_DIR$/node_modules/app.js">
       <provider selected="true" editor-type-id="text-editor">
         <state line="1" column="47" selection-start="74" selection-end="74" vertical-scroll-proportion="0.03837472" />
@@ -366,11 +389,6 @@
         <state line="1038" column="0" selection-start="31000" selection-end="31078" vertical-scroll-proportion="0.644186" />
       </provider>
     </entry>
-    <entry file="file://$PROJECT_DIR$/productOptions.js">
-      <provider selected="true" editor-type-id="text-editor">
-        <state line="162" column="56" selection-start="5662" selection-end="5662" vertical-scroll-proportion="0.48604652" />
-      </provider>
-    </entry>
     <entry file="file://$PROJECT_DIR$/product.js">
       <provider selected="true" editor-type-id="text-editor">
         <state line="32" column="25" selection-start="1175" selection-end="1175" vertical-scroll-proportion="-2.2744186" />
@@ -406,9 +424,25 @@
         <state line="9920" column="0" selection-start="948539" selection-end="948539" vertical-scroll-proportion="2.8556702" />
       </provider>
     </entry>
+    <entry file="file://$PROJECT_DIR$/.gitignore">
+      <provider selected="true" editor-type-id="text-editor">
+        <state line="106" column="0" selection-start="1354" selection-end="1354" vertical-scroll-proportion="0.8142077">
+          <folding />
+        </state>
+      </provider>
+    </entry>
+    <entry file="file://$PROJECT_DIR$/productOptions.js">
+      <provider selected="true" editor-type-id="text-editor">
+        <state line="162" column="56" selection-start="5662" selection-end="5662" vertical-scroll-proportion="1.0928962">
+          <folding />
+        </state>
+      </provider>
+    </entry>
     <entry file="file://$PROJECT_DIR$/index.html">
       <provider selected="true" editor-type-id="text-editor">
-        <state line="29" column="49" selection-start="825" selection-end="825" vertical-scroll-proportion="0.36690646" />
+        <state line="23" column="71" selection-start="662" selection-end="662" vertical-scroll-proportion="0.2776204">
+          <folding />
+        </state>
       </provider>
     </entry>
   </component>
diff --git a/README.md b/README.md
index 3d5e14f..bdbc77d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,72 @@
-zza.data
-========
+# Zza Data
+
+**Zza Data** is sample data for a fictive pizza takeout and delivery chain named "**Zza**."  Here is Zza himself!
+
+![Zza](https://raw.github.com/IdeaBlade/zza.data/master/images/logo.png)
+
+Zza Data is also a pure JavaScript application for generating that data in a variety of formats. Today it supports three formats: 
+
+- JSON
+- SQL Server (T-SQL)
+- Mongo
+
+We hope it supports more formats in time. Send in your pull requests.
+
+## Why Zza? ##
+We build many forms-over-data sample application. The data model for such apps has to be simple enough to understand quickly but rich enough to represent typical scenarios for forms-over-data applications. We wanted something fresher and more fun than that tired old Microsoft Northwind database. We couldn't find anything so we wrote "zza.data".
+
+We want to share it with you, so you can build your own sample apps without having to waste time (like we did) dreaming up a data model, populating a database with sample data, and having to explain its schema and contents to the world. We all want to move on to the fun stuff, the application itself.
+
+The Zza project is just underway and of course the documentation lags behind the project code. Here's what we can tell you now.
+
+## The Zza Story ##
+Zza takes orders over the phone for pick-up and delivery; perhaps in your app, the `Customer` can order online. The customer self-identifies by name (“Skippy”) and phone number. If the customer wants the order delivered, s/he supplies a delivery address.
+
+The customer places an `Order` for pizzas, salads, and beverages. The app remembers the customers and their orders.
+
+The customer picks from a `Product` catalog of pizzas, salads, and beverages. S/he can customize pizzas and salads (`Products`) with toppings (`ProductOptions`). The resulting order is a three level structure: `Order` -> 'OrderItem` -> `OrderItemOption`.
+
+Pricing is a bit tricky ... deliberately. The pizzas and salads come in different sizes, each size with its own price for the base pizza/salad and a price per extra topping. Some of the toppings are free (spices). Some of the toppings cost double the topping-price-per-product-size. The parameters of the calculation are captured in properties of the `ProductSize`, `Product` and `ProductOption` entities.
+
+There are a few more wrinkles. You can read the code in "zzaGenerator.js" yourself (we'll explain these pricing and other 'rules' in more detail in future). 
+
+The rules don't really matter. The point is to introduce enough complexity so you can demonstrate how you'd implement and represent business rules in your application.
+
+The primary keys are all called `id`. They are all integer ... except the `Customer` id which is a Guid in JSON and SQL generations and a `ObjectId` in the MongoDb generation. We needed a little variety for extra "realism". 
+
+The Customer has an address because s/he might order again. But the order has its own delivery address because ... well, you might order a pizza while you're at your friend's house; you don't want Zza to deliver it to your home, right?
+
+## The Model ##
+We need the following "Entity Types" to make this work:
+
+**Mutable Entities**
+
+- Customer
+- Order
+- OrderItem (pizza, salad, beverage)
+- OrderItemOption (toppings, salad dressings)
+
+**Reference Entities**
+
+- OrderStatus (Ordered, PickedUp, Delivered, Canceled, Pending)
+- Product
+- ProductOption
+- ProductSize 
+
+### SQL v No-SQL ###
+Those entities map one-for-one to SQL tables and their are foreign keys to support the associations.
+
+It wouldn't be any fun if they also mapped one-for-one to Mongo collections. So they don't. Each `Order` is a document with a collection of `OrderItem`s which, in turn, each have a collection of `OrderItemOption`s. Naturally some of the data are denormalized; for example, you'll find the customer name repeated in each order. The `Order` document is optimized for the application's checkout screen and to tell the kitchen staff how to fill your order.
+
+## Get the data ##
+Launch *index.html* in a browser and click one of the generator buttons to produce the JSON or T-SQL script for the Zza database. The output appears in a scrollable box on screen. Click the [Select all] button and copy the output; paste it whereever it's useful to you.
+
+For example, you could paste the JSON output into a new JavaScript file in your project and use that as the basis for mock data objects while you're developing your front-end.
+
+You could run the "T-SQL" generator, open SQL Server Management Studio (SMS), open a new query window, paste, and execute. It should produce a SQL Server database for you. You'll also find a recent generation of the T-SQL script in the *output* folder as "ZzaDatabaseGen.sql"; you can just play that SQL script in Visual Studio or in SQL SMS.
+
+The mongo generator is a little different. It requires node.js. Assuming you have node and MongoDb installed, you fire up your MongoDb server and then run "mongoGen.js" in node. That will (re)create a "Zza" database.
+
+## Images ##
+You want pictures in your app, right? Well, we've got `Product` pictures of pizzas, salads and beverages in the *images* folder. Feel free to contribute better ones (the beverages are all the same at the moment).
+
diff --git a/index.html b/index.html
index 34928ec..55b3ff9 100644
--- a/index.html
+++ b/index.html
@@ -26,7 +26,7 @@
 <body>
 <h1>Zza Data Generator</h1>
 <button id="json" class="pure-button">JSON</button>
-<button id="tsql" class="pure-button">T-SQL script</button>
+<button id="tsql" class="pure-button">T-SQL</button>
 <p></p>
 <div id="container" class="scroll">
     <pre id="output"></pre>