Action Point Dashboard
  • Action Point Dashboard Documentation
  • INTRODUCTION
    • Glossary / Terminology
    • FAQ
    • Releases / Changelog*
    • Report an Issue / Contact us
  • PRODUCT / END-USER DOCUMENTATION
    • Overview
      • Objectives
      • User roles and permissions
    • Action Points Dashboard Navigation
    • Overall User Interface
    • List of Action Points
    • Action Points Workflow
    • Action Points
      • Creation of Action Point
      • Modification of Action Point
      • Completion of Action Point
      • Additional options for Action Point
    • Connections to other modules
      • Overview
      • Action Points in FAM
      • Action Points in Field Monitoring
      • Action Points in TPM
      • Action Points in Trip Management (T2F)
  • TECHNICAL DOCUMENTATION
    • Architecture
    • Development Setup
    • Deployment / DevOps
    • Data Model
    • Fixtures & management commands
    • API Documentation
      • Error Handling
    • Backend module structure
    • Integration with permissions framework
    • Frontend
      • Module structure
      • Build process
      • Tests
Powered by GitBook
On this page
  • Files structure
  • Elements directory structure
  • Component structure
  • Polytempl
  1. TECHNICAL DOCUMENTATION
  2. Frontend

Module structure

Files structure

I - .circleci/ - gulp-tasks/ - images/ - src/ I - elements/ - tests/ - index.html - package.json - bower.json - polymer.json - ...Other configuration files

In the application root directory you can find all configuration files for development and build process. Here you can find Docker config files, configs for code linting, tests, gulp config, node server. Code for gulp tasks is placed in gulp-tasks/ directory. You can find all application elements in src/elements/ directory. In tests/ directory you can find entry point for tests.

Elements directory structure

I - app-mixins/ - common-elements/ - core-elements/ I - app-config/ - app-shell/ (main application component) - app-main-header/ - app-sidebar/ - data-elements/ - pages/ I - action-points-page-components/ - not-found-page-view/ - styles-elements/

In elements/ you can find:

  1. app-mixins/ directory with all application mixins (permission, common-methods, error-handler and ect.)

  2. common-elements/ directory with elements that are used in different pages several times

  3. core-elements/ directory with application config element, application main element and base elements common to all modules (header, sidebar)

  4. data-elements/ directory with elements used to request static data from server (user-data, static-data)

  5. pages/ directory with elements divided by pages, which will be lazy loaded

  6. styles-elements/ with common styles elements

Component structure

Almost all application components are split into 3 separate files:

  • html file with component template

  • js file with components logic

  • scss file with component styles

Polytempl

Polytempl plugin helps combine separate components files and resolve imports.

You need to specify the special html comment to combine your html template file with js and scss files:

<!-- inject styles './path_to_styles.scss'-->

or 

<!-- inject scripts './path_to_logic.js'-->
<!--import [polymer]-->
<!--import [module-styles, page-layout-styles, shared-styles, list-tab-main,
            static-data-behavior, search-and-filter, engagements-list-data, 
            pages-header-element, permission-controller, etools-app-config]-->
PreviousFrontendNextBuild process

Last updated 6 years ago

You can specify the special html comment for imports. Polytempl will look for this components in your src files at first and than in bower_components/ . See more details about Polytempl .

here