Quick Start

Get up and running with Sand Framework in minutes!

Prerequisites

  • Docker and Docker Compose

  • Node.js 16+ (for web frontend)

  • Python 3.8+

  • Solana CLI tools (optional)

Installation

  1. Clone the repository:

git clone <repository-url>
cd sandframework

  1. Set up environment variables:

cp .env.example .env

  1. Configure your .env file with required credentials:

# LLM Provider
LLM_PROVIDER=openai
OPENAI_API_KEY=your_key_here

# Database
DATABASE_URL=postgresql://user:pass@localhost:5432/dbname

# Message Broker
BROKER_URL=amqp://user:pass@rabbitmq:5672/

# Discord (if using bot)
DISCORD_TOKEN=your_token_here

  1. Start the services:

docker-compose up -d

🎉 Congratulations! Sand Framework is now running locally.

Verify Installation

  1. Check API status:

curl http://localhost:8000/health

  1. Access API documentation:

open http://localhost:8000/api/docs

  1. Test Discord bot (if configured):

/sand health

Next Steps

PreviousIntroductionNextInstallation

Last updated