Skip to content
Yoichiro Tanaka edited this page Jan 20, 2016 · 18 revisions

Code Structure

This document describes you code structure of this software. Mainly, I write down about the directory structure and the purpose of each file.

Directories

  • / - Build files, Configuration files, and etc.
  • /app - This directory has one HTML file and the manifest.json file.
  • /app/_locales/en - There is one message resource file for English.
  • /app/icons - This directory has some image files.
  • /app/scripts - There are some JavaScript files.
  • /app/styles - There is one css stylesheet definition file.
  • /test - Currently, all files are garbages...
  • /docs - Currently, there is one image file which is referenced by the README.md file.

At least, if you are programmer, first you should enter the /app/scripts directory and see each JavaScript files to understand this app's behaviors.

Files

For Building

This file defines all procedures to build this software with grunt.

The building procedures are using many sub tasks for the grunt. This file defines the used sub tasks.

This software is using bower to manage packages. This software is using Polymer 0.5, and this file defines each polymer components as depended packages.

JSHint is a software to check the Javascript Code as a static code analzing. This file defines each check rule. That is, this file has many flags to turn on/off each checking process. JSHint is executed by the grunt tool automatically, because the Gruntfile.js has the task to execute the JSHint.

HTML

This is a HTML file for the screen which users see at first when this software is launched. For instance, this HTML file has one button to start mounting the Dropbox storage. The click event is handled by the function defined in the /app/scripts/window.js file. This HTML elements consists of Polymer components.

JavaScript

This window.js file is in charge of handling each click event fired on the window.html. For instance, there are the events below:

  • Mount button click event
  • Setting button click event
  • Opened files limit radio buttons change event

Each event handler is assigned by the assignEventHandlers() function.

Other

This is a manifest file which is needed for Chrome Apps.

Clone this wiki locally