Do-We

The Hot Date Boyz--back at it again!

##Table of Contents

• Team Members
• Tech Stack, API's and Third-party Tools
• Folder and File Structure
• Setting up the Development Environment
• Starting the app
• System Architecture
• Database Schema
• Add Publishers
• Worker Description
• License

##Team Members

##Tech Stack, API's and Third-party Tools

• Vue for rendering views
• Vuex for managing state
• Vue-Router for controlling navigation within the client
• Node.js and Express for serving static pages and services.
• MongoDB for database with Mongoose as an ODM. See our Database section for more details.
• PubNub for controlling interactions between groups of clients with WebRTC for peer to peer video streaming.
• Webpack & Babel
• Passport for managing user authentication.

##Folder and File Structure

online-speed-dating/
|
|--App/
    |
    |--Client/
        |
        |--Components/
            |
            |--Vue components (data/functionality)
        |--Dependencies/
            |
            |--pubnub WebRTC SDK
        |--Router/
            |
            |--routes (Vue-Router client-side routing)
        |--Templates/ 
            |
            |--Vue templates
        |--app
        |--index
        |--store (Vuex state management)
        |--stylesheet
    |--Database/
        |
        |--models/
            |
            |--Mongoose models
        |--config (connects to the database)
        |--schema (establish mongodb schema for database entries)
    |--Server/
        |
        |--handlers/
            |
            |--Handlers for server side functionality
        |--routes
            |
            |--apiRouter
            |--authRouter
            |--eventRouter
        |--middleware
        |--router
        |--server
|
|--Documentation/
|

##Setting up the Development Environment

##How to start the app

###Install dependencies:

• navigate to the root directory and run npm install
• Make sure mongodb is installed and configured

####Get API Keys for PubNub

• Register with PubNub
• Create a project on your PubNub user profile
• Make sure that 'Presence' is toggled on in the 'Application Add-Ons' section for your keyset (Don't worry, it's free).
• For further information on request/connection limits for free users, see PubNub's pricing page

###Starting the app

• Start your

• Open a new terminal window and navigate to the root file of the project

• run

• Open a terminal window and navigate to the root file of the project

• If this is the first time you are starting the app

• run

• Open a new terminal window and navigate to the root file of the project

• run npm start

• You can now open http://localhost:4321/

##System Architecture

##Database

##Do the thing To do something that our app wants to do

##License ???