-
Notifications
You must be signed in to change notification settings - Fork 23
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.
- / - 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.
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.