WIP: 0.3

.bookignore

@@ -0,0 +1,7 @@
+bin/*
+config/*
+data/*
+lib/*
+private/*
+test/*
+views/*

.gitignore

@@ -13,5 +13,5 @@ results
 
 npm-debug.log
 
-/public/css/*
+/public/css/maki.css
 node_modules

.nodemonignore

@@ -1,2 +1,6 @@
 public/*     # static files
 #/views/*
+data/*
+docs/*
+examples/*
+node_modules/*

README.md

@@ -1,8 +1,10 @@
 Maki
 ==============
+![Project Status](https://img.shields.io/badge/status-alpha-red.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/martindale/maki.svg?branch=master&style=flat-square)](https://travis-ci.org/martindale/maki)
 [![Coverage Status](https://img.shields.io/coveralls/martindale/maki.svg?style=flat-square)](https://coveralls.io/r/martindale/maki)
-[![Community](https://chat.maki.io/badge.svg)](https://chat.maki.io/)
+[![Total Contributors](https://img.shields.io/github/contributors/martindale/maki.svg?style=flat-square)](https://github.com/martindale/maki/contributors)
+[![Sustainability](https://img.shields.io/gratipay/team/fabric-foundation.svg?style=flat-square)](https://gratipay.com/Fabric-Foundation)
 
 The complete stack for building extensible apps, faster than ever.  Hand-roll your application by telling Maki what your application does, and it takes care of the rest – without getting in your way if you want to customize it.
 
@@ -87,39 +89,18 @@ Maki aims to be as lightweight as possible while still offering a base stack tha
 ## Documentation
 For our documentation, see the `docs/` subfolder.
 
-## Recommended Deployment
-I use [pm2](https://github.com/unitech/pm2) (`npm install pm2 -g`) to manage node apps in production, and I strongly recommend you do, too.  It's got awesome features like log management, process clustering, and automatic startup scripts.
-
-For Maki by itself, `pm2 start maki.js` will produce the following:
-```bash
-> pm2 start maki.js
-PM2 Process launched
-┌──────────┬────┬─────────┬───────┬────────┬───────────┬────────┬─────────────┬─────────────┐
-│ App name │ id │ mode    │ PID   │ status │ restarted │ uptime │      memory │    watching │
-├──────────┼────┼─────────┼───────┼────────┼───────────┼────────┼─────────────┼─────────────┤
-│ maki     │ 0  │ cluster │ 93966 │ online │         0 │ 0s     │ 25.652 MB   │ unactivated │
-└──────────┴────┴─────────┴───────┴────────┴───────────┴────────┴─────────────┴─────────────┘
- Use `pm2 desc[ribe] <id>` to get more details
-```
-
-You can check on running processes using `pm2 ls`.  For example, on a server with multiple running services:
-```bash
-> pm2 ls
-┌────────────┬────┬─────────┬───────┬────────┬───────────┬────────┬──────────────┬─────────────┐
-│ App name   │ id │ mode    │ PID   │ status │ restarted │ uptime │       memory │    watching │
-├────────────┼────┼─────────┼───────┼────────┼───────────┼────────┼──────────────┼─────────────┤
-│ para       │ 0  │ cluster │ 21140 │ online │         0 │ 14d    │  69.734 MB   │ unactivated │
-│ worker     │ 1  │ cluster │ 21142 │ online │         0 │ 14d    │  83.996 MB   │ unactivated │
-│ bot        │ 2  │ cluster │ 21223 │ online │         1 │ 14d    │ 115.543 MB   │ unactivated │
-│ maki       │ 3  │ cluster │ 21154 │ online │         0 │ 14d    │  92.676 MB   │ unactivated │
-│ soundtrack │ 4  │ cluster │ 32655 │ online │         3 │ 18h    │ 324.176 MB   │ unactivated │
-└────────────┴────┴─────────┴───────┴────────┴───────────┴────────┴──────────────┴─────────────┘
- Use `pm2 desc[ribe] <id>` to get more details
-```
+## Contributors
+- [@martindale](https://github.com/martindale)
+- [@chrisinajar](https://github.com/chrisinajar)
+- [@jlukic](https://github.com/jlukic)
+- [@unusualbob](https://github.com/unusualbob)
+- [@overra](https://github.com/overra)
+- [@unChaz](https://github.com/unChaz)
+- [@toriborealis](https://github.com/toriborealis)
 
-For production monitoring, see also `pm2 monit`, `vtop` (available via `npm install vtop -g`), and [StrongLoop](http://strongloop.com/).
+Special thanks to [the whole Maki community](https://maki.io/people) for supporting this project with their presence and more.
 
-Use environment variables for configuration.  See `config/index.js` for a list of configurable values.
+Many, many other contributors deserve recognition for their work on the open source projects that have made Maki possible.  See `package.json` for just a few of them.
 
 ## Spirit
 Please feel free to submit changes to this repo via pull requests!  We're trying to keep this as general and flexible as possible, so anyone can take the project and run with it.

SUMMARY.md

@@ -0,0 +1,60 @@
+# Summary
+
+### Overview
+- [Why are we here?][why-are-we-here]
+
+### Developers
+- [Getting Involved](source/developers/getting-involved.md)
+- [Community Projects](https://slack-files.com/T09HF1HK9-F2PNSMKD2-00a26fd573)
+- [Running in Production](source/snippets/production.md)
+
+### Examples
+- [Simple Content Site](source/examples/content.md)
+- [Advanced Web Service](source/examples/infrastructure.md)
+- [Robust Multi-Platform App](source/examples/robust.md)
+
+### Tutorials
+- [Overview](source/tutorials/index.md)
+- [Initial Setup](source/tutorials/initial-setup.md)
+- [Hello, World!](source/tutorials/hello-world.md)
+- [Adding Resources](source/tutorials/adding-resources.md)
+
+### Technology
+- [Overview][fabric-overview]
+- [The Fabric Protocol][fabric-protocol]
+
+### Documentation
+- [Overview](docs/index.md)
+- [Resources](docs/resources.md)
+- [Components](source/snippets/components.md)
+- [Datastores](docs/datastores.md)
+- [Plugins](docs/plugins.md)
+- [Services](docs/services.md)
+
+### Community
+* [Introduction](source/snippets/introduction.md)
+- [Community Guidelines][community-guidelines]
+- [Outstanding Community Tasks][outstanding-tasks]
+
+[chat]: https://chat.maki.io/
+[slack]: https://www.youtube.com/watch?v=W8_tGC8pNvI
+[slack-apps]: https://slack.com/downloads
+[why-are-we-here]: source/snippets/why-are-we-here.md
+[maki-vs-fabric]: https://maki-dev.slack.com/files/chrisinajar/F16EBB88K/Elevator_Speach
+[fabric-overview]: source/snippets/fabric-overview.md
+[fabric-protocol]: https://maki-dev.slack.com/files/martindale/F170LP2HL/fabric_protocol_specification.md
+[community-guidelines]: https://maki-dev.slack.com/files/martindale/F1565BS5P/Community_Guidelines.md
+[outstanding-tasks]: https://maki-dev.slack.com/files/martindale/F1ARP5JKV/Outstanding_Community_Tasks
+[maki-remote]: https://github.com/martindale/maki-remote
+[maki-auth-flex]: https://github.com/martindale/maki-auth-flex
+[waffle]: https://waffle.io/martindale/maki
+[snarl]: https://github.com/martindale/snarl
+
+[#product]: https://maki.io/topics/product
+[#community]: https://maki.io/topics/community
+[#projects]: https://maki.io/topics/projects
+[#meta]: https://maki.io/topics/meta 
+[#hacking]: https://maki.io/topics/hacking 
+[#development]: https://maki.io/topics/development 
+[#meetups]: https://maki.io/topics/meetups 
+[#beer]: https://maki.io/topics/beer 

book.json

@@ -0,0 +1,10 @@
+{
+  "theme": "dark",
+  "plugins": ["exercises", "edit-link", "page-toc"],
+  "pluginsConfig": {
+    "edit-link": {
+      "base": "https://github.com/martindale/maki/edit/community",
+      "label": "Edit This Page"
+    }
+  }
+}

components/404.jade

@@ -0,0 +1,17 @@
+dom-module#maki-undefined
+  template
+    .ui.text.container
+      h1 Nothing known.
+      p We're sorry, but we don't know anything about that.  Here are some alternative resources you might be interested in.
+
+      .ui.horizontal.segments
+        .ui.segment
+          p One
+        .ui.segment
+          p Two
+        .ui.segment
+          p Two
+  script.
+    Polymer({
+      is: 'maki-undefined'
+    });

components/analytics.jade

@@ -0,0 +1,18 @@
+dom-module#maki-analytics
+  script.
+    Polymer({
+      is: 'maki-analytics',
+      properties: {
+        config: { type: Object }
+      },
+      ready: function() {
+        console.log('[MAKI:ANALYTICS]', 'ready');
+        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+        ga('create', '#{config.analytics.id}', 'auto');
+        ga('send', 'pageview');
+      }
+    })

components/api-index.jade

@@ -0,0 +1,86 @@
+dom-module#maki-api-index
+  template
+    .ui.vertical.stripe.segment.content
+      h3 Generally
+      p <strong>Formatting:</strong> All endpoints serve both JSON and HTML, controlled by the <code>Accept</code> header of your request.  You can force the formatting of any resource using the <code>format</code> parameter: i.e., append <code>?format=json</code> to any URL to retrieve the underlying resource as JSON.
+      p <strong>Events:</strong> Any endpoint can be connected to with a WebSocket, and updates to that resource will be served to you as messages.  These messages will be formatted as JSON-PATCH arrays, wrapped in JSON-RPC with the method name <code>patch</code>.  The <code>channel</code> parameter will correspond to the resource's route.  For more information, see <a href="https://github.com/martindale/maki#pubsub">the Maki documentation on PubSub &amp; Messaging</a>.
+      p All endpoints can also be interacted with via the following HTTP verbs:
+      pre
+        code.
+          query, get: GET
+          create: POST, PUT
+          update: PATCH
+          delete: DELETE
+
+      - var methodMap = { query: 'GET', get: 'GET', create: 'POST', update: 'PATCH', destroy: 'DELETE' }
+
+      .ui.stackable.grid
+      .four.wide.column
+        .overlay
+          .ui.labeled.vertical.menu
+            for resource in resources
+              a.item(href="/api##{resource.plural.toLowerCase()}")
+                if (resource.options.icon)
+                  i.icon(class="#{resource.options.icon}")
+                | #{resource.plural}
+      .twelve.wide.column
+        .ui.cards
+          for resource in resources
+            .ui.fluid.card
+              .content
+                .header
+                  if (resource.options.icon)
+                    i.icon(class="#{resource.options.icon}")
+                  a(href="##{resource.plural.toLowerCase()}", name="#{resource.plural.toLowerCase()}") #{resource.plural}
+                .description #{resource.description}
+                .description
+                  h4 Paths
+                  table.ui.table
+                    thead
+                      tr
+                        th Operation
+                        th HTTP Method
+                        th Route
+                    tbody
+                      for method in Object.keys(resource.routes)
+                        tr
+                          td #{method}
+                          td #{methodMap[method]}
+                          td #{resource.routes[method]}
+
+                  h3 Attributes
+                  table.ui.table
+                    thead
+                      tr
+                        th Name
+                        th Type
+                        th Required?
+                        th Allowed Values
+                        th Default
+                        th Min
+                        th Max
+                        th Validator
+                    tbody
+                      for name in Object.keys(resource.attributes)
+                        - var attribute = resource.attributes[name]
+                        tr
+                          td #{name}
+                          td #{(attribute.type && attribute.type.name) ? attribute.type.name : attribute.type}
+                          td #{attribute.required}
+                          td #{attribute.enum}
+                          td #{attribute.default}
+                          td #{attribute.min}
+                          td #{attribute.max}
+                          td #{attribute.validator}
+
+  script.
+    Polymer({
+      is: 'maki-api-index',
+      ready: function() {
+        $('.overlay').visibility({
+          type: 'fixed',
+          offset: 80
+        });
+      }
+    });
+