Directory Layout

Related documents

• Development Process Guide

Table of contents

• Project root directory layout
• The source/ directory
  • The source/app/ directory
  • The source/airportData/ directory
  • The source/image directory
  • The source/service directory
  • The source/cdv directory
  • The build/ directory
  • The doc/ directory

Project root directory layout

The project root contains the following files and directories:

• build/
  A directory created by the Makefiles where app images, lint results, and documentation files are built. See The build/ directory.
• doc/
  The documentation source directory.
• node_modules/
  A directory with imported NodeJS modules. Created by npm.
• scripts/
  Local shell, Python, and NodeJS scripts used by the build process. See Scripts Reference.
• source/
  The main source directory. See The source/ directory
• app.mk
  The sub-makefile for most aircraft apps.
• <appName>.mk...
  Sub-makefiles for other apps.
• Makefile
  The main Makefile.
• TestApp.mk
  Sub-makefile for the Testapp.
• package.json
  The npm package file. This mostly contains the dependency list for the build process.

The source/ directory

The source/ directory contains the following files and directories:

• source/airportData/
  Content for building the airport database.
• source/app/
  The client source code for all apps and the common infrastructure.
• source/cdv/
  Content for creating Cordova images for each app.
• source/image/
  Content for building the graphics for each app.
• source/service/
  Content for building the server-side services. XXX change to server?

The source/app/ directory

The source/app/ directory contains the following directories:

• source/app/<appId>/
  The source code for the <typeName> app. For most POH Performance apps, the app's full name is "<typeName> Performance".
• source/app/common/
  The source code for the common infrastructure and utilities.
• source/app/Testapp/
  The source code for the Testapp.

The source/app/common/ directory

This directory contains the source code for the common infrastructure and utilities. It contains the following files and directories:

• source/app/common/aero/
  Common files related to aeronautical functions.

• source/app/common/mvcs/
  The MVCS infrastructure code.

• source/app/common/option/
  Optional modules. These must be explicitly imported as required. These include

  • ctxDraw.js
    A canvas drawing package module. See the Canvas Drawing Module Reference.
  • speech.js
    An interface module to DOM speech function. See the speech Reference.
  • units.js
    A units conversion module. See the Units Module Reference.
  • unitTest.js
    A built-in unit test module. See the unitTest Reference.

• source/app/common/page/
  App pages that are independent of the specific app or aircraft type. These are:

  • Checklist page
    Displays a checklist. The app must provide a separate Procedures page to select the checklist.
  • Hold entry page
    Displays an interactive hold entry computer.
  • People page
    A page that maintains a user-editable database of people and their weights.
  • Risk page
    A Flight Risk Assessment Tool (FRAT) page.
  • Settings page
    An app settings page.
  • Terms of Use page
    A page that displays the POH Performance Terms of Use and records the users acknowledgment.
  • Test page
    A page that executes a self-test when opened and displays the results.
  • Trips page
    A page that maintains a user-editable database of trips. Each trip consists of the same settings recorded on the Quick Setup page.

• source/app/common/script/ directory
  This directory contains files that will be included in the app as scripts instead of modules. The directory includes a source/app/common/script/lib directory containg external libraries to be included as scripts. Currently, this includes:

  • Jquery
  • Modernizer
  • UAParser

  The directory also includes a polyfill.js that contains general polyfills for advanced JavaScript features that may be more recent than the Technology use.

The source/app/<appId>/ directory

The unique part of each app is in a directory under source/app/<appId>. Typically, the appId is the first word in the full app name. For example, 'C182' for the 'C182 Performance' app. This directory typically contains the following files and directories.

• buildStamp/
  This directory contains most of the app-specific code. The directory is called buildStamp because this name is typically replaced with a build-specific timestamp or hash to ensure that all the contained files and directories fetched by the client will be the versions for this build. See The Service Worker and caching. The directory typically contains the following:
  • buildStamp/internalData/
    Built-in app databases such as the airport database.
  • buildStamp/image/
    App images.
  • buildStamp/modelData/
    Data for aircraft models as well as typeData.js that contains type-wide data.
  • buildStamp/page/
    App-specific pages.
  • buildStamp/app.js
    The app startup code. See App Startup.
  • buildStamp/manifest.json
    The PWA manifest file. See Web app manifests.
  • buildStamp/svFormat.js
    An optional file that contains state variable info object for state variables formats that are widely-used in the app.
• .htaccess
  The Apache .htaccess file to be placed in the application root on the server. Typically this redirects API access to the service sub-directory.
• externalData
  Downloadable app databases that are not built into the app, such as the latest airport database update. Because this data is not under buildStamp, the contents will be shared among all currently active app versions. Any data placed here must be backward compatible or have its own versioning convention. The current contents are:
  • externalData/airportData.json
    A downloadable version of the airport database in JSON format. This is only used to update the built-in version. Airport database updates
  • externalData/airportDataTimestamp.json
    The timestamp for airportData.json. The app fetches this file when the app is started or resumed after a long period of inactivity. If the timestamp is newer than the most recent update or built-in database, then the large airportData.json is fetched and the database is updated.
• eslint.config.mjs
  The eslint configuration file for this app's code.
• index.html
  The index.html file for this app.
• serviceWorker.js
  The Service Worker for this app. See The Service Worker and caching.

The source/app/Testapp/ directory

The source/airportData/ directory

This directory contains

The source/image directory

This directory contains the source files used to create images associated with each app. Eacj app has a separate directory named by the appId containing source files such as:

• The Android store feature-graphic
• The Android store icon
• The Apple app store store icon
• The aircraft top view image for the app icon and runway diagram.

The source/service directory

This directory contains server-side files to implement each app's API. It contains a common/ directory containing the service files common to all apps. The directory also contains a directory for each app named by the appId containing any files unique to the app.

Currently, all the PHP service files are common to all apps. Each app has a unique .htaccess file that directs requests to the common files a sets the POH_APP environment variable with the app's appId.

The source/cdv directory

This directory contains the files needed to build Cordova native apps. Each app, has a directory named by its appId, that contains a Cordova config.xml and a res/ directory containing native app image resources.

The build/ directory

The build directory contains the results of the build process. It contains the following directories:

• build/cdv/
  This directory contains the Cordova source image for each app under a directory named by the appId.
• build/doc/
  This directory contains the HTML files that have been converted from the Markdown on the doc/ directory.
• build/lint
  This directory contains the eslint results for each JavaScript source file. This allows the build process to detect which files need to be linted without linting all files.
• build/web/
  This directory contains the Web server image for each app under a directory named by the appId.

The doc/ directory

This directory contains all the project documentation. For the most part, this conssits of Markdown files, but it make include other formats, including video.