Getting Started

This guide will help you get started with the Dev Kit for AI. The guide covers the basic setup, configuration, and running the application using Docker Compose. It is designed to help you quickly set up a local development environment for building AI-powered SaaS applications.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or higher) - For frontend development
• Python (v3.8 or higher) - For backend development
• Docker and Docker Compose - For running services locally

Additionally, we highly recommend using git for version control.

Quick Start

1. Environment Setup

Copy the example environment file and configure it:

cp .env.example .env

Edit the .env file with your configuration. Later in the guide, you'll find instructions for setting up AI providers and file storage.

2. Start with Docker Compose

The easiest way to get started is using Docker Compose:

make dev

This will start:

• Backend API on port 8000
• Frontend on port 3000
• Database (PostgreSQL) on port 5432

You can also use the following commands to manage the services:

# Stop all services
make down

# Show logs for all services
make show-logs

3. Access the Application

• Frontend: http://localhost:3000
• Backend API: http://localhost:8000/api/v1/health/detailed
• API Documentation: http://localhost:8000/docs