# Module structure

## Files structure

{% tabs %}
{% tab title="application\_root/:" %}
I\
\- `.circleci/` \
\- `gulp-tasks/` \
\- `src/` \
        I\
        \- `assets/` \
                I\
                \- `images/` \
                \- `js/` \
        \- `elements/` \
        \- `tests/` \
        \- `index.html` \
        \- `manifest.json` \
\- `package.json` \
\- `bower.json` \
\- `polymer.json` \
\- ...Other configuration files
{% endtab %}
{% endtabs %}

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 source files in `src/` directory.

`src/` directory contains `index.html` file, `assets/` directory with images and polyfill script, and `elements` directory with all application components.

## Elements directory structure

{% tabs %}
{% tab title="application\_root/src/elements/ :" %}
I\
\- `app-behaviors/` \
\- `common-elements/` \
        I\
        \-  `engagement-overview-components/` \
        \- `engagement-report-components/` \
        \- ...Other common elements\
\- `core-elements/` \
        I\
        \- `app-config/` \
        \- `app-shell/` (main application component)\
        \- `app-main-header/` \
        \- `app-sidebar/` \
\- `data-elements/`  \
\- `pages/` \
        I\
        \- `audits-page-components/` \
        \- `engagements-page-component/s` \
        \- ...Other components related to specific page\
\- `styles-elements/` 
{% endtab %}
{% endtabs %}

In `elements/` you can find:

1. `app-behaviors/` directory with all application behaviors (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 data from server (get-partner-data, update-engagement and ect.)
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&#x20;

```
<!-- inject scripts './path_to_logic.js'-->
```

You can specify the special html comment for imports. Polytempl will look for these components in your src files at first and then in `bower_components/` . See more details about Polytempl [here](https://www.npmjs.com/package/polytempl).

```
<!--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]-->
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://razortheory.gitbook.io/financial-assurance-module-documentation/technical-documentation/frontend/module-structure.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.