Project folder structure

• <app-name>/
  • bower.json - front-end dependencies managed by Bower
  • gulp.config.js - Gulp configuration
  • gulpfile.js - Gulp task definitions
  • karma.conf.js - Karma test runner configuration
  • mlpm.json - MLPM dependencies
  • package.json - Node.js dependencies managed with npm
  • bower_components/
    • installed front-end dependencies managed by Bower
  • data/
    • dictionary-large.xml - word list for spelling suggestions
  • deploy/ - Files used by Roxy to configure server when you run ./ml local bootstrap
    • ml-config.xml - Project-specific MarkLogic configuration - This file is the ultimate record of how Roxy bootstrap will configure MarkLogic. Any settings in here will be set on the server. The properties files override various of these configurations.
    • build.properties - Project-specific Roxy settings (for sharing with teammates)
    • local.properties - Environment-specific Roxy settings (for your local machine; not checked into version control)
    • (other files used by Roxy...)
  • mlpm_modules/ - Installed MarkLogic dependencies managed by MLPM (created after running mlpm install in case of dependencies)
  • node-server/ - Files for the thin Node.js middle-layer, which performs proxying (largely to bypass CORS). It is built as an Express listener.
  • node-modules/ - Dependencies for node and gulp, installed by npm
  • rest-api/ - Files that Roxy will put on the server when you run ./ml local deploy rest
    • config/options/
    • MarkLogic search options
    • ext/
      • MarkLogic REST API extensions
    • transforms/
      • Marklogic REST transforms
  • sample-data.zip - 3000 sample JSON files representing people - See the README for information on how to load them
  • src/ - custom XQuery or server-side Javascript that Roxy will deploy into the app modules database when you run ./ml local deploy modules
  • ui/
    • index.html - Entry point for browser to load and launch Angular application
    • specs.html - Used for running tests
    • app/ - AngularJS files
      • app.js - Initialization of Angular application
      • create/
        • sample create page and controller, allowing creation of a person
      • detail/
        • details page and controller - sample details page, which will display JSON data out-of-the-box, using the ng-json-explorer library
      • landing/
        • initial landing page, for developers. It should be removed when no longer needed
      • root/
        • a global template for your application
      • route/
        • routes.js configures your application's routes for the bundled angular-ui-router
      • search/
        • search page, service, and controller, landing page
        • this depends heavily on the ml-search-ng library, so look there for docs on how to update/extend it
      • user/
        • (user service, and controller, for handling login/logout)
    • fonts/
      • fonts from fontawesome and glyphicons, used by Bootstrap
    • images/
      • logos and other UI images
    • styles/
      • *.less - Less code, which will be compiled to css by gulp. Includes MarkLogic UI style templates.