Skip to main content

๐Ÿณ Quick Start with Docker

Get Aicser Platform running in 5 minutes with Docker - the fastest way to experience AI-powered analytics.

โšก What You'll Getโ€‹

In just a few minutes, you'll have:

  • โœ… AI-powered chart generation running locally
  • โœ… Sample data to explore and visualize
  • โœ… Web interface accessible in your browser
  • โœ… API endpoints ready for integration
  • โœ… Authentication service for user management

๐ŸŽฏ Prerequisitesโ€‹

  • Docker Desktop installed and running
  • Git for cloning the repository
  • 4GB+ RAM available for containers
  • Modern web browser (Chrome, Firefox, Safari, Edge)

๐Ÿš€ Step-by-Step Setupโ€‹

1. Clone the Repositoryโ€‹

git clone https://github.com/aicser-platform/aicser-world
cd aicser-world

2. Start All Servicesโ€‹

docker-compose up -d

This command will:

  • Pull all required Docker images
  • Start all services in the background
  • Set up networking between services
  • Initialize databases with sample data

3. Wait for Services to Startโ€‹

# Check service status
docker-compose ps

# View logs (optional)
docker-compose logs -f

โฑ๏ธ Expected startup time: 2-3 minutes for first run

4. Access Your Aicser Platformโ€‹

Once all services show "Up" status, open your browser:

ServiceURLPurpose
๐ŸŽจ Chat2Chart Frontendhttp://localhost:3000Main AI analytics interface
๐Ÿ”Œ Chat2Chart APIhttp://localhost:8000Backend API endpoints
๐Ÿ” Auth Servicehttp://localhost:5000Authentication API
๐Ÿ“Š Cube.js Analyticshttp://localhost:4000High-performance analytics engine

๐Ÿงช Test Your Installationโ€‹

Create Your First Chartโ€‹

  1. Open http://localhost:3000
  2. Upload the sample data file: demo_sales_data.csv
  3. Ask a question like: "Show me sales by month"
  4. Watch AI generate a beautiful chart instantly!

Sample Questions to Tryโ€‹

  • "What are the top 5 products by revenue?"
  • "Show me sales trends over time"
  • "Create a pie chart of sales by region"
  • "What's the correlation between price and quantity sold?"

๐Ÿ”ง Configuration Optionsโ€‹

Environment Variablesโ€‹

Create a .env file in the root directory for customization:

# Copy example environment file
cp env.example .env

# Edit with your preferences
nano .env

Key Configuration Options:

# AI Model Configuration
OPENAI_API_KEY=your_openai_key_here
AZURE_OPENAI_API_KEY=your_azure_key_here
GOOGLE_AI_API_KEY=your_google_key_here

# Database Configuration
POSTGRES_DB=aicser_platform
POSTGRES_USER=aicser_user
POSTGRES_PASSWORD=secure_password

# Security
JWT_SECRET=your_jwt_secret_here
ENCRYPTION_KEY=your_encryption_key_here

Port Customizationโ€‹

If you need different ports, modify docker-compose.yml:

services:
chat2chart-client:
ports:
- "3001:3000" # Change 3001 to your preferred port
chat2chart-server:
ports:
- "8001:8000" # Change 8001 to your preferred port

๐Ÿ› Troubleshootingโ€‹

Common Issues & Solutionsโ€‹

1. Port Already in Useโ€‹

# Check what's using the port
lsof -i :3000

# Kill the process or change ports in docker-compose.yml

2. Services Not Startingโ€‹

# Check service logs
docker-compose logs chat2chart-server
docker-compose logs auth-service

# Restart specific service
docker-compose restart chat2chart-server

3. Database Connection Issuesโ€‹

# Check database status
docker-compose exec postgres psql -U aicser_user -d aicser_platform

# Reset database (โš ๏ธ destroys data)
docker-compose down -v
docker-compose up -d

4. AI Services Not Workingโ€‹

# Check API keys are set
docker-compose exec chat2chart-server env | grep API_KEY

# Test AI endpoint
curl http://localhost:8000/health

Performance Optimizationโ€‹

For better performance on development machines:

# Increase Docker resources
# Docker Desktop โ†’ Settings โ†’ Resources โ†’ Advanced
# Memory: 8GB+ | CPUs: 4+ | Swap: 2GB+

# Use host networking (Linux/macOS)
docker-compose --profile performance up -d

๐Ÿš€ Next Stepsโ€‹

Now that you have Aicser running locally:

  1. ๐Ÿ“Š Create Your First Chart - Experience AI analytics
  2. ๐ŸŽฌ Watch the Demo - Learn the interface
  3. ๐Ÿ  Deploy to Production - Self-host for your team
  4. ๐Ÿ”Œ Explore the API - Integrate with your systems
  5. ๐Ÿค– Learn AI Features - Master AI-powered analytics

๐Ÿ†˜ Still Having Issues?โ€‹

๐Ÿ”„ Development Workflowโ€‹

For developers who want to modify the code:

# Stop services
docker-compose down

# Make code changes
# ... edit files ...

# Rebuild and restart
docker-compose up -d --build

# Or run in development mode
docker-compose -f docker-compose.dev.yml up -d

๐ŸŽ‰ Congratulations! You now have Aicser Platform running locally. Create your first chart โ†’ to experience the power of AI-powered analytics.