example.plugin_package.json

// This file is parsed with the jsoncfg python package
// It supports comments like this one.

// Directories are the location of plugin_package.json
{
    // Some details about this Peek App
    "plugin": {
        "title": "Peek App - Noop",
        "packageName": "peek_plugin_noop",
        // The name of the root python package
        "version": "#PLUGIN_VER#",
        "buildNumber": "#PLUGIN_BUILD#",
        "buildDate": "#BUILD_DATE#",
        "creator": "Synerty Pty Ltd",
        "website": "www.synerty.com"
    },
    // The Peek Platform services that this plugin needs to run
    "requiresServices": [
        "logic",
        "worker",
        "agent",
        "field",
        "office",
        "storage"
    ],
    // Settings specific to the peek_office_service service
    "client": {
        // The directory where the angular2 route is for the client site
        // EG "frontend/client"
        "angularFrontendAppDir": "client_fe",
        // The main module for the angular2 route
        // This must be in the "angularFrontendAppDir"
        // EG "plugin-noop.module"
        "angularMainModule": "plugin-noop.module"
    },
    // Settings specific to the peek_logic_service service
    "logic": {
        // The directory where the angular2 route is for server admin site
        // EG "frontend/client"
        "angularFrontendAppDir": "server_fe",
        // The main module for the angular2 route
        // This must be in the "angularFrontendAppDir"
        // EG "plugin-noop.module"
        "angularMainModule": "plugin-noop.module"
    },
    // Settings specific to the database service
    // The database is migrated by the peek_logic_service and used from both the server and worker
    // services
    "storage": {
        // The alembic directory where the database schema migration scripts are stored
        "alembicDir": "alembic"
    },
    // Settings specific to the peek_worker_service service
    "worker": {},
    // Settings specific to the peek_agent_service service
    "agent": {}
}