cApps Quickstart

Prerequisites

• Python 2.7+

• Node.js 23+

• pnpm

• docker

Note for Windows Users: WSL 2 is required.

Using the Quickstart Repository

1. Clone the github repository

git clone [coming soon]
cd nasdaiq

1. Install requirements and build the required packages

pnpm i && pnpm build

1. Copy the sample .env file and add your API keys:

cp .env.example .env

~/.env

# API Keys
GEMINI_API_KEY=your_key_here
OPENAI_API_KEY=your_key_here
ANTHROPIC_API_KEY=your_key_here
BROWSER_AGENT_KEY=your_key_here

Configuring your cApp

You can pre-define the actions and goals for the cApp which provides a configuration for the framework to scaffold for you.

1. Add configuration file in the project root with the name capp.config.json

{
    "capp_id": {
        "name": "Expedai",
        "logo_path": "https://url_to_logo/image.jpg",
        "primary_color": "#hex_color",
        "secondary_color": "#hex_color",
        "initial_prompts": {
            "goals": ["book_user_flights", "get_flight_info"],
            "actions": ["book_flight", ""],
            "analysis": "Analysis style guidelines...",
            "narrative": "Communication style guidelines..."
        }
    }
}

1. Run the script to scaffold the project with your configuration:

pnpm run scaffold --config="capp.config.json"

Running the Application

1. Start the application:

# Start Terminal Interface
pnpm start

1. The agent will be live in your terminal and you can begin interacting with it.

Troubleshooting

Common issues and solutions:

1. Missing .env file:

   • Make sure all required API keys are included in your .env file and verify that they are valid and not expired.

2. Incorrect NodeJS Version:

   • Verify your NodeJS version: node -v

   • Must be 23.3.0 or higher

   • Consider using nvm to manage Node versions

3. "Module not found" Error

• Ensure the module is listed in your dependencies or devDependencies in package.json.

• Run npm install or yarn install to install missing modules.

• If the issue persists, delete the node_modules folder and reinstall:

  rm -rf node_modules
  pnpm install

1. "npm WARN" Messages During Installation

• Review the warnings and update any outdated packages:

  npm install <package>@latest