Configuration

Developer Agent Kit — documentation written for AI agents, readable by humans.

.jay File

Optional YAML file at project root configuring the dev server:

devServer:
  portRange:
    - 3000
    - 3100
  pagesBase: ./src/pages
  componentsBase: ./src/components
  publicFolder: ./public
editorServer:
  portRange:
    - 3101
    - 3200

Key Fields

• devServer.pagesBase — Root directory for pages (default: ./src/pages)
• devServer.componentsBase — Root directory for components
• devServer.publicFolder — Static assets directory
• devServer.portRange — Port range for the dev server

Plugin Configuration (config/)

The config/ folder holds plugin configuration files generated by jay-stack setup:

config/
├── project.conf.yaml       # Project name and metadata
└── wix-data.yaml           # Plugin-specific config (auto-generated)

Plugins create their config files here during setup. The location is configured via configBase in the .jay file (defaults to ./config).

Project Init (src/init.ts)

The project can have an init.ts for project-level initialization:

import { makeJayInit, registerService } from '@jay-framework/fullstack-component';

export const init = makeJayInit()
  .withServer(async () => {
    // Register project-level services
    registerService(MY_SERVICE, createMyService());

    // Return data for client
    return { locale: 'en-US' };
  })
  .withClient((data) => {
    // Client-side init
    console.log('Locale:', data.locale);
  });

Init runs after all plugin inits, in dependency order.

package.json Scripts

{
  "scripts": {
    "dev": "jay-stack-cli dev",
    "validate": "jay-stack-cli validate",
    "definitions": "jay-cli definitions src",
    "build": "npm run definitions",
    "setup": "jay-stack-cli setup",
    "agent-kit": "jay-stack-cli agent-kit"
  }
}

---

About this document

This page is part of the Jay Stack Agent Kit — documentation generated from the framework source and written primarily for AI agents. The language and structure are optimized for machine consumption — expect precise, specification-style prose rather than narrative documentation. Learn more about the Agent Kit →