Tack Client Application

Directory Structure Breakdown

Note: some auto-generated top-level directories have been ommitted for brevity or excluded from the .zip for size considerations.

Top Level

• app/ --- client application
• gulp/ --- build tasks
• platforms/ --- Cordova platforms
• plugins/ --- Cordova plugins
• Gulpfile.coffee --- build configuration
• package.json --- dependency management
• config.xml --- Cordova configuration

app/

• img/ - Images (only stores logo.png)
• sass/ --- SASS & style dependencies
• coffee/ --- CoffeeScript source files

app/coffee

• behaviors/ --- Behaviors
• components/ --- Components
• config/ --- Configuration files
• modules/ --- Modules
• services/ --- Services
• manifest.coffee --- manifest
• app.coffee --- Application class

app/coffee/behaviors

Behaviors are view mixins used in both Components and Modules.

app/coffee/components

Components are routeless services with views that are accessible anywhere in the application.

• component_name/ --- Each Component in a separate directory
  • component.coffee --- Component controller
  • views/ --- Component views
    • layout.coffee
    • templates/ --- Component templates
      • component.jade

app/coffee/config

Configuration files for Cross-Origin Requests (CORS), JSON Web Token (JWT), and Marionette.js

app/coffee/modules

Modules represent collections of endpoints in the application. They always have a Router and at least one Route, and often have Models, Collections, and Services.

NOTE: The complexity of directory structure in Modules and Components may seem redundant, but the opinions enforced by this structure work effectively to ensure scalability of the application from a development perspective.

• module_name/ --- Each Module in a separate directory
  • route_01/
    • views/ --- Route views
      • layout.coffee
      • templates/ --- Route templates
        • module.jade
  • route_02/
  • .../ --- (modules can have many routes)
  • collection.coffee --- Backbone.Collection
  • model.coffee --- Backbone.Model
  • router.coffee --- Router
  • service.coffee --- Service

app/coffee/services

Services are workers that are available to perform specific background tasks. They are routeless, and they neither maintain nor manage any views.