Soom

Getting Started

Complete guide to setting up your development environment and getting started with Soom AI

Getting Started

Welcome to Soom AI! This guide will help you set up your development environment and get started building AI-powered applications on our platform.

Prerequisites

Before you begin, ensure you have the following installed on your system:

System Requirements

  • Operating System: macOS 10.15+, Windows 10+, or Linux (Ubuntu 18.04+)
  • Node.js: Version 18.17.0 or higher
  • Package Manager: npm, yarn, or pnpm
  • Git: Version 2.0 or higher
  • Docker: Version 20.10+ (optional, for containerized development)

Development Tools

  • Code Editor: VS Code, WebStorm, or your preferred IDE
  • Terminal: Command line interface
  • Browser: Chrome, Firefox, Safari, or Edge (latest versions)

Account Setup

1. Create Your Account

  1. Visit soom.io and click "Sign Up"
  2. Choose your account type:
    • Individual Developer: Free tier with basic features
    • Team: Collaborative development with team features
    • Enterprise: Advanced features and dedicated support
  3. Verify your email address
  4. Complete your profile setup

2. Get Your API Keys

  1. Navigate to your Dashboard
  2. Go to "API Keys" section
  3. Generate a new API key for your project
  4. Save your API key securely (you'll need it for authentication)

Development Environment Setup

1. Install Soom CLI

The Soom CLI is our command-line tool for managing your AI applications and agents.

# Install via npm
npm install -g @soom/cli

# Or install via yarn
yarn global add @soom/cli

# Or install via pnpm
pnpm add -g @soom/cli

2. Authenticate with Soom

# Login to your Soom account
soom login

# Verify your authentication
soom whoami

3. Initialize Your Project

# Create a new project
soom init my-ai-project

# Navigate to your project directory
cd my-ai-project

# Install dependencies
npm install

Project Structure

Your new Soom AI project will have the following structure:

my-ai-project/
├── src/
│   ├── agents/          # AI agents
│   ├── apps/            # Applications
│   ├── apis/            # API endpoints
│   └── config/          # Configuration files
├── tests/               # Test files
├── docs/                # Documentation
├── .soom/               # Soom configuration
├── package.json         # Project dependencies
└── README.md            # Project documentation

Configuration

1. Environment Variables

Create a .env file in your project root:

# Soom API Configuration
SOOM_API_KEY=your_api_key_here
SOOM_API_URL=https://api.soom.io/v1
SOOM_ENVIRONMENT=development

# Database Configuration (if using local database)
DATABASE_URL=postgresql://username:password@localhost:5432/soom_dev

# Redis Configuration (if using local Redis)
REDIS_URL=redis://localhost:6379

2. Soom Configuration

The .soom/config.json file contains your project configuration:

{
  "project": {
    "name": "my-ai-project",
    "version": "1.0.0",
    "description": "My first Soom AI project"
  },
  "agents": {
    "enabled": true,
    "defaultModel": "gpt-4"
  },
  "apis": {
    "enabled": true,
    "port": 3000
  },
  "deployment": {
    "environment": "development",
    "region": "us-east-1"
  }
}

Your First AI Agent

Let's create your first AI agent to get familiar with the platform:

1. Create an Agent

# Create a new agent
soom agent create my-first-agent

# This will create a new agent in src/agents/my-first-agent/

2. Agent Code

The generated agent will look like this:

// src/agents/my-first-agent/index.ts
import { Agent } from '@soom/agent-sdk';

export class MyFirstAgent extends Agent {
  constructor() {
    super({
      name: 'my-first-agent',
      description: 'My first AI agent',
      model: 'gpt-4',
      capabilities: ['text-generation', 'reasoning'],
    });
  }

  async process(input: string): Promise<string> {
    // Your agent logic here
    return `Hello! I received: ${input}`;
  }
}

3. Test Your Agent

# Start the development server
soom dev

# Test your agent
soom agent test my-first-agent "Hello, world!"

Your First API

Let's create a simple API endpoint:

1. Create an API

# Create a new API endpoint
soom api create hello-world

2. API Code

// src/apis/hello-world/index.ts
import { APIRoute } from '@soom/api-sdk';

export const helloWorld: APIRoute = {
  method: 'GET',
  path: '/hello',
  handler: async (req, res) => {
    res.json({
      message: 'Hello from Soom AI!',
      timestamp: new Date().toISOString(),
    });
  },
};

3. Test Your API

# Start the development server
soom dev

# Test your API
curl http://localhost:3000/hello

Development Workflow

1. Local Development

# Start the development server
soom dev

# This will start:
# - API server on http://localhost:3000
# - Agent runtime
# - Hot reload for code changes

2. Testing

# Run all tests
soom test

# Run specific test
soom test agents/my-first-agent

# Run with coverage
soom test --coverage

3. Building

# Build your project
soom build

# Build for production
soom build --production

Deployment

1. Deploy to Development

# Deploy to development environment
soom deploy --environment development

2. Deploy to Production

# Deploy to production environment
soom deploy --environment production

3. Monitor Your Deployment

# View deployment logs
soom logs --environment production

# Monitor deployment status
soom status --environment production

Next Steps

Now that you have your development environment set up, here's what you can do next:

1. Explore the Platform

2. Build Your First Application

  • Create an AI Chatbot: Build a conversational AI application
  • Develop an API: Create RESTful APIs for your AI services
  • Build an Agent: Develop custom AI agents for specific tasks

3. Join the Community

  • Discord: Join our developer community
  • GitHub: Contribute to open-source projects
  • Documentation: Explore comprehensive guides and API references

4. Get Certified

  • Junior AI Engineering: Learn the fundamentals
  • AI Agent Developer: Master agent development
  • AI Implementation Strategist: Lead AI initiatives

Troubleshooting

Common Issues

Authentication Errors

# Re-authenticate
soom logout
soom login

API Key Issues

# Verify your API key
soom whoami

# Update your API key
soom config set api-key your_new_api_key

Port Conflicts

# Use a different port
soom dev --port 3001

Getting Help

  • Documentation: Check our comprehensive documentation
  • Community: Ask questions in our Discord community
  • Support: Contact our support team for enterprise customers

Resources

How is this guide?

Platform Overview

Comprehensive overview of the Soom AI platform architecture, capabilities, and core components

Key Features

Explore the powerful features and capabilities that make Soom AI the leading industry-vertical AI platform

On this page

Getting Started
Prerequisites
System Requirements
Development Tools
Account Setup
1. Create Your Account
2. Get Your API Keys
Development Environment Setup
1. Install Soom CLI
2. Authenticate with Soom
3. Initialize Your Project
Project Structure
Configuration
1. Environment Variables
2. Soom Configuration
Your First AI Agent
1. Create an Agent
2. Agent Code
3. Test Your Agent
Your First API
1. Create an API
2. API Code
3. Test Your API
Development Workflow
1. Local Development
2. Testing
3. Building
Deployment
1. Deploy to Development
2. Deploy to Production
3. Monitor Your Deployment
Next Steps
1. Explore the Platform
2. Build Your First Application
3. Join the Community
4. Get Certified
Troubleshooting
Common Issues
Authentication Errors
API Key Issues
Port Conflicts
Getting Help
Resources