Getting Started

This guide will help you quickly get started with Gaia-X.

Installation

Using npm

npm install gaia-x

Using yarn

yarn add gaia-x

Basic Usage

Creating an Application

import { createApp } from 'gaia-x'

// Create an application instance
const app = createApp({
  // Application configuration
  name: 'my-app',
  version: '1.0.0'
})

// Start the application
app.start()

Adding Modules

import { createModule } from 'gaia-x'

// Create a module
const myModule = createModule({
  name: 'my-module',
  // Module configuration
})

// Add the module to the application
app.use(myModule)

Configuration Options

Gaia-X provides a rich set of configuration options to meet different needs:

Application Configuration

OptionTypeDefaultDescription
namestring'app'Application name
versionstring'1.0.0'Application version
debugbooleanfalseWhether to enable debug mode

Module Configuration

OptionTypeDefaultDescription
namestring-Module name (required)
dependenciesarray[]Module dependencies

Example Projects

Check out our example projects to learn more about how to use Gaia-X.

Client Development Commands

The client code is located in the apps/client directory. Execute the following commands in this directory to build the client.

# Install dependencies
pnpm install

# Start development environment
pnpm dev

# Build client application
pnpm build

# Build and package client
pnpm build:win     # Windows version
pnpm build:mac     # macOS version

# Clean build files
pnpm clean

MCP Service Commands

# Initialize MCP runtime environment
pnpm run mcp:init

# Install MCP tools
pnpm run mcp:install <tool-name>

# Start MCP server
pnpm run mcp:start

# List installed MCP tools
pnpm run mcp:list

Management Center Commands

# Start management center API service
cd apps/admin/server
go run main.go

# Start management center frontend
cd apps/admin/web
pnpm install
pnpm dev

Troubleshooting Commands

# Check Python environment
pnpm run check:python

# Check Node.js environment
pnpm run check:node

# Test MCP tool connectivity
pnpm run test:mcp

# View logs
pnpm run logs

Next Steps