Overview
This section will cover the www
directory, which should contain all of assets that will be used at runtime.
index.html (generated)
This file is generated from resources/<platform>/index.master.html
when running the gulp config
task. It is the initial page that will be loaded by Cordova when the application starts.
See gulp config
in Gulp Tasks and Base Framework: Build Schemes for more details.
Warning
This file will be removed when executing the gulp clean
or gulp clean:config
tasks and should not be commited to source control.
js
This contains plain JavaScript source files loaded by www/index.html
.
js/src (generated)
This directory is generated when running the gulp ts
task in a scheme in which the debug flag is set to true. It contains all of the TypeScript source code so the application can be debugged in Chrome.
This directory will not be present in non-debug builds.
See Base Framework: Build Schemes for more details.
Warning
This directory will be removed when executing the gulp clean
or gulp clean:ts
tasks and should not be committed to source control.
js/boot1.js
This is the first-level boot loader loaded by www/index.html
. It handles any low-level boot tasks before delegating to the second-level boot loader (src/Framework/Boot2.ts
).
js/build-vars.js (generated)
This file is generated when running the gulp config
task. It contains build information such as version number, build timestamp, and debug flag. It also contains configuration key/value pairs from resources/config/config.yml
.
The file's contents are accessible via the Configuration service (or as an Angular constant).
See gulp config
in Gulp Tasks and Base Framework: Build Schemes for more details.
Warning
This file will be removed when executing the gulp clean
or gulp clean:ts
tasks and should not be committed to source control.
js/bundle.js (generated)
This file is generated when running the gulp ts
task. It contains all the output from compilation of the TypeScript files from the src
directory.
Its contents will be minified in non-debug builds.
Warning
This file will be removed when executing the gulp clean
or gulp clean:ts
tasks and should not be committed to source control.
js/bundle.d.ts (generated)
This file is generated when running the gulp ts
task. It contains the TypeScript type descriptions for the www/js/bundle.js
file.
It is primarily used by unit tests and will only be present during a debug build.
Warning
This file will be removed when executing the gulp clean
or gulp clean:ts
tasks and should not be committed to source control.
js/bundle.js.map (generated)
This file is generated when running the gulp ts
task. It contains mapping information to map the generated source from www/js/bundle.js
to the TypeScript source copied to www/js/src
in debug builds.
It is used when debugging the source in a browser and will only be present during a debug build.
Warning
This file will be removed when executing the gulp clean
or gulp clean:ts
tasks and should not be committed to source control.
js/templates.js
This file is generated when running the gulp templates
task. It contains all the Angular HTML templates from the src/Views
directory.
This file will be removed when executing the gulp clean
or gulp clean:templates
tasks and should not be committed to source control.
See gulp templates
in Gulp Tasks and Base Framework: Views for more details.
lib (generated)
This directory is generated when running the gulp libs
task. It contains all the third-party libraries for use at runtime. It is populated via the Bower package manager using the bower.json
file.
See gulp libs
in Gulp Tasks for more details.
Warning
This directory will be removed in when executing the gulp clean
or gulp clean:libs
tasks and should not be committed to source control.
images
This directory can be used to store images that will be used at runtime.
css
This directory can be used to store plain CSS files.
css/bundle.css (generated)
This file is generated when running the gulp sass
task. It contains the output from compilation of the SASS files using the src/Styles/Index.scss
file.
Its contents will be minified in non-debug builds.
See gulp sass
in Gulp Tasks for more details.
Warning
This file will be removed when executing the gulp clean
or gulp clean:sass
tasks and should not be committed to source control.
css/bundle.css.map (generated)
This file is generated when running the gulp sass
task. It will contain mapping information to map the generated CSS to the original SASS source.
See gulp sass
in Gulp Tasks for more details.
Warning
This file will be removed when executing the gulp clean
or gulp clean:sass
tasks and should not be committed to source control.