Generated files

Edit Document

This is the project scaffolding that the generator creates.

File structure

|-- .editorconfig
|-- .gitignore
|-- .jshintrc
|-- README.md
|-- package.json
|-- gulpfile.js
|   |-- config.js
|   |-- index.js
|   |-- lib
|   |   |-- backup-generator.js
|   |   |-- handleErrors.js
|   |-- tasks
|       |-- backup-generator.js
|       |-- backup-image.js
|       |-- browserSync.js
|       |-- build-development.js
|       |-- build-production.js
|       |-- clean.js
|       |-- default.js
|       |-- fonts.js
|       |-- help.js
|       |-- html.js
|       |-- images.js
|       |-- javascript.js
|       |-- json.js
|       |-- prod.js
|       |-- sass.js
|       |-- server.js
|       |-- svg-sprite.js
|       |-- watch.js
|       |-- zip.js
|-- src
    |-- index.html
    |-- base
    |   |-- images
    |   |   |-- desktop.png
    |   |   |-- loading.gif
    |   |   |-- logo.png
    |   |-- js
    |   |   |-- main.js
    |   |-- styles
    |       |-- style.scss
    |-- test-300x250
        |-- index.html
        |-- images
        |   |-- logo.png
        |-- js
        |   |-- banner.animation.js
        |   |-- banner.js
        |   |-- banner.loader.js
        |-- styles
            |-- style.scss
            |-- base
                |-- _banner.scss
                |-- _preloader.scss

File breakdown

A brief description of the generated files.

File
Description
File
.editorconfig
Description
Used to help developers define and maintain consistent coding styles between different editors and IDEs
File
.gitignore
Description
Used to ignore files when committing to a git repository
File
.jshintrc
Description
Helps to detect errors and potential problems in code
File
package.json
Description
Contains project node/npm package data
File
README.md
Description
Readme file for developers
File
gulpfile.js/config.js
Description
Gulp config
File
gulpfile.js/index.js
Description
Import gulp tasks
File
gulpfile.js/lib/backup-generator.js
Description
The backup generator functions
File
gulpfile.js/lib/handleErrors.js
Description
Stop gulp from exiting when there is a syntax error
File
gulpfile.js/tasks/backup-generator.js
Description
Task for generating backup images
File
gulpfile.js/tasks/backupImage.js
Description
Task for prompting the user if there is no backup image
File
gulpfile.js/tasks/browserSync.js
Description
Task for fast live reload injection
File
gulpfile.js/tasks/build-development.js
Description
Task that runs development tasks
File
gulpfile.js/tasks/build-production.js
Description
Task that runs production tasks
File
gulpfile.js/tasks/clean.js
Description
Task that deletes assets before build
File
gulpfile.js/tasks/default.js
Description
Task for enabling gulp shortcut instead of typing gulp build:development
File
gulpfile.js/tasks/fonts.js
Description
Task for copying font files to public directory
File
gulpfile.js/tasks/help.js
Description
Task for providing help with gulp commands
File
gulpfile.js/tasks/html.js
Description
Task for copying html files to public directory
File
gulpfile.js/tasks/images.js
Description
Task for copying and compressing image files to public directory
File
gulpfile.js/tasks/javascript.js
Description
Task for copying js files to public directory
File
gulpfile.js/tasks/json.js
Description
Task for copying json files to public directory
File
gulpfile.js/tasks/prod.js
Description
Task for enabling gulp prod shortcut instead of typing gulp build:production
File
gulpfile.js/tasks/sass.js
Description
Task for compiling sass files into css in the public directory
File
gulpfile.js/tasks/server.js
Description
Task for setting up a local production server
File
gulpfile.js/tasks/svg-sprite.js
Description
Task for converting svg files into an svg spritesheet, a png spritesheet and the sprite dimensions in a css file
File
gulpfile.js/tasks/watch.js
Description
Task for watching files for changes and triggering browser sync to reload the page on update
File
gulpfile.js/tasks/zip.js
Description
Task for compressing files for delivery
File
src/index.html
Description
The preview page
File
src/base/images/desktop.png
Description
Desktop icon
File
src/base/images/loading.gif
Description
Loading icon
File
src/base/images/logo.png
Description
The campaign logo
File
src/base/js/main.js
Description
The preview page functions
File
src/base/styles/style.scss
Description
The preview page styles
File
src/[banner-name]-[banner-size]/index.html
Description
The example html file
File
src/[banner-name]-[banner-size]/images/logo.png
Description
Example logo
File
src/[banner-name]-[banner-size]/js/banner.animation.js
Description
The main creative file
File
src/[banner-name]-[banner-size]/js/banner.js
Description
Base banner functions
File
src/[banner-name]-[banner-size]/js/banner.loader.js
Description
Used to load files politely
File
src/[banner-name]-[banner-size]/styles/style.scss
Description
Imports the base styles for the banner
File
src/[banner-name]-[banner-size]/styles/base/_banner.scss
Description
Base banner styles
File
src/[banner-name]-[banner-size]/styles/base/_preloader.scss
Description
Base preloader styles

Contributors

pyramidium