Skip to main content
Version: 3.1

Getting Started

Developing is like Cooking — you don't need to understand the chemistry behind every ingredient to make a great dish. What you need is a good recipe, the right tools, and a kitchen where everything is roughly where you'd expect it. This documentation is that kitchen. Start with the basics, follow the steps, and don't worry if things smell a little odd at first.

This section provides a practical entry point into the Operaide development workflow. You will understand the core building blocks of the platform, and follow a clear path from first run to productive development.

Use this section as your baseline reference before moving into deeper technical chapters. It is intentionally focused on fast onboarding and the minimum context you need to build, test, and iterate safely.

Before You Begin

To follow this guide, you need access to a running Operaide instance. If you do not have access yet, contact your administrator.


What You Will Learn

In this documentation, you will learn to:

  • 🧩 Master the core concepts of Operaide
  • 🚀 Build, deploy, and iterate on Applications
  • 🤖 Connect AI providers and make LLM calls
  • 🗄️ Persist and query data with Agent DB
  • 🔗 Connect external services, APIs, and tools
  • ✨ Accelerate development with AI-assisted Vibe Coding/Engineering

Prerequisites

You don't need to be an expert — but the following background will help you get started quickly:

  • Programming experience in TypeScript (ES6+ fundamentals, Node.js basics)
  • Basic familiarity with Zod — used throughout for schema validation and type inference
  • Familiarity with REST APIs, command line and Git
  • Some experience prompting Large Language Models

If you encounter an unfamiliar term while reading, the Glossary defines all platform-specific concepts.

Recommended Online Course: TypeScript Masterclass 2025 Edition - React + NodeJS Project