App configuration

Your application root directory contains three key configuration files:

app.yao

The app.yao file is the main configuration file for your application. It defines essential details like the application name, version, description, and other settings.

Here’s an example structure of the app.yao file:

{
  "name": "Demo Application", // Application name
  "short": "Demo", // Short name for the application
  "description": "Another yao application", // Brief description
  "version": "0.10.4", // Application version

  "adminRoot": "admin", // Admin panel root path (default: "admin")

  /**
   * Hook: setup
   * Script to run after installation. Useful for initializing application data.
   */
  "setup": "scripts.tests.AppSetup",

  /**
   * Hook: afterLoad
   * Introduced in yao v0.10.4
   * Runs after the application is loaded. Use this to dynamically load DSLs before the HTTP server starts.
   */
  "afterLoad": "scripts.tests.AppAfterLoad",

  /**
   * Hook: afterMigrate
   * Introduced in yao v0.10.4
   * Runs after the application is migrated. Ideal for setting up initial data during `yao migrate`.
   */
  "afterMigrate": "scripts.tests.AppAfterMigrate",

  /**
   * Custom menu process for the admin panel.
   * Default process: "flows.menu". Create your own if needed.
   * @see /flows/menu.flow.yao
   */
  "menu": { "process": "flows.menu", "args": [] },

  /**
   * Introduced in yao v0.10.4
   * HTTP Server Root Directory Configuration (Optional)
   */
  "public": {
    /**
     * Maps public backend script source roots to real paths.
     * Useful for SUI backend script development in dev mode.
     */
    "sourceRoots": { "/public": "/data/templates/default" },

    // Routes for SUI web pages
    "rewrite": [
      { "^\\/assets\\/(.*)$": "/assets/$1" }, // SUI assets
      { "^\\/(.*)$": "/$1.sui" } // File system routes
    ]
  },

  "optional": {
    /**
     * Enables remote cache to reduce requests (e.g., Select Component options queries)
     * by caching data in the browser.
     */
    "remoteCache": false,

    /**
     * Introduced in yao v0.10.4
     * Admin menu configuration:
     *  - layout: "1-column" (single column), "2-columns" (menu + sub-menu)
     *  - hide: hides the menu and sub-menu
     *  - showName: displays menu names
     */
    "menu": { "layout": "2-columns", "showName": true },

    /**
     * Optional AI chatbot service configuration.
     * If omitted, the Neo service will not be available.
     */
    "neo": { "api": "/neo" }
  },

  /**
   * Introduced in yao v0.10.4
   * Moapi service configuration (Optional).
   * Moapi is not required for the application to function.
   * Get a secret key from Moapi or use an AI Connector.
   * @see https://moapi.ai for details.
   */
  "moapi": {
    "channel": "global",
    "mirrors": ["https://api.moapi.ai"],
    "secret": "$ENV.MOAPI_SECRET" // Supports environment variables
  }
}

tsconfig.json

The tsconfig.json file is the TypeScript configuration file for your application. It defines the TypeScript compiler options and paths for your application.

Here’s an example structure of the tsconfig.json file:

{
  "compilerOptions": {
    "target": "es6", // Do not change
    "paths": {
      "@yao/*": ["./.types/*"], // Yao Runtime APIs and types. ( Do not change )
      "@scripts/*": ["./scripts/*"] // Custom Process Scripts. ( Do not change )
    },
    "lib": ["es2017", "dom"] // dom is required for SUI web pages
  }
}

Environment variables

The .env file contains the environment variables for your application. It is used to store sensitive information like API keys, database credentials, and other secrets.

You can add custom environment variables to the .env file and access them in your application through the utils.env.* processes.

Here’s an example structure of the .env file:

YAO_DB_DRIVER="sqlite3"  # Database driver (sqlite3, mysql, postgres)
YAO_DB_PRIMARY="./db/yao.db"  # Primary database file or DSN
YAO_ENV="development" # Application environment (development, production)
YAO_HOST="0.0.0.0"   # Application http server listen address (default: 0.0.0.0, all interfaces)
YAO_PORT=5099        # Application http server listen port (default: 5099)
YAO_LOG_MODE="TEXT"  # Log mode (TEXT, JSON)
YAO_LOG="./logs/application.log"  # Log file path
YAO_SESSION_STORE="file"  # Session store (file, redis)
YAO_SESSION_FILE="./db/.session" # Session file path | Required for file session store

📜 Database Connection Strings

For SQLite:

SQLite connection is the file path to the database file:

"/path/to/database.db"

Example:

YAO_DB_DRIVER="sqlite3"
YAO_DB_PRIMARY="./db/yao.db"

For MySQL:

MySQL support is available starting from version 5.7, with version 8.0 or higher recommended.

MySQL connection strings are in the format:

"[user]:[password]@tcp([server]:[port])/[database]?charset=utf8mb4&parseTime=True&loc=Local"

Example:

YAO_DB_DRIVER="mysql"
YAO_DB_PRIMARY="webuser:webpass@tcp(127.0.0.1:3306)/website?charset=utf8mb4&parseTime=True&loc=Local"

For PostgreSQL:

Support for PostgreSQL is planned for future releases. Stay tuned for updates! 😊

📜 Full List of Environment Variables