Structure

Folder structure

Since the application is modular we want to keep the files structured by their modules. Each part has its own folder in the /app-directory. Only the main application files to start the app are placed in the root-directory, /app/*. These files are:

• index.html (root-file for the application)
• app.js (root script file for the application)
• routes.js (routing file for the application)
• .htaccess (for directory permissions)
• settings.xml (contains the settings)

Each part consists of controllers (*.ctrl.js) and html-templates (*.view.html). If some other files are needed, such as directives (*.dir.js) those also needs to placed in the corresponding folder. In a later stadium each folder can be converted into its own module, if needed.

---

File structure

Each file should start with a comment containing the function of the file. Furthermore each function and declaration should have an description.

TODO-comments

If a TODO comment is added then also an issue should be linked by using #<issue_number>. If no issue for that todo yet exists, then add that issue.