Skip to content
Alex Gian edited this page Mar 16, 2015 · 20 revisions

Overview

├── app.js                - The main application
|
├── CONTRIBUTING.md       - Very Important! - Instruction for proper GitHub usage
├── README.md             - README
├── apidoc.js             - The config settings for apidocjs inline doc generator
├── apidoc_header.js      - The header file apidocjs looks at to generate header
├── gulpfile.js           - Automation scripts for build, deploy, testing, 
|                           auto-documentation generation
├── karma.config.js       - Config settings for karama
├── newrelic.js           - New Relic settings for app health monitoring
├── package.json          - App dependencies 
|
├── public/               - Public static files 
├── config/               - Configuration files 
├── test/                 - Karma Tests 
├── auth/                 - Authentication library
├── view/                 - Hogan views
└── routes/               - App routing for web api, mobile api, and mobile pages

Routing Structure

├── app.js              - Simply requires('./routes') to get all routes
└── routes              - Folder containing routes
    ├── index.js        - Requires all routes from the webapp and api folder
    ├── webapp          - Routes for web app
    │   ├── business    
    │   ├── checkin     
    │   ├── signature   
    │   └── auth        
    ├── webapi          - Routes for the web app API
    └── api             - Routes for REST API
        ├── auth        
        ├── form        
        └── appointment 

An example component in routes/api or routes/webapi

business  
├── index.js                - Routes
└── business.controller.js  - Controller for business routes
Clone this wiki locally