This directory contains example code demonstrating how to use DeCube components.

• Location: quickstart/
• Description: Basic introduction to DeCube components
• Run: cd quickstart && go run main.go

• Location: snapshot-example/
• Description: Demonstrates snapshot creation, querying, and management
• Run: cd snapshot-example && go run main.go

Before running examples:

1. Start DeCube services:

   docker-compose up -d

2. Wait for services to be ready:

   ./scripts/health-check.sh

3. Install dependencies:

   go mod download

Each example directory contains:

• main.go: Example code
• README.md: Example-specific documentation

To run an example:

cd examples/<example-name>
go run main.go

When creating new examples:

1. Create a new directory under examples/
2. Add a main.go file with your example code
3. Add a README.md explaining what the example demonstrates
4. Follow the existing code style and patterns
5. Update this README to include your example

package main

import (
    "fmt"
    "log"
)

func main() {
    fmt.Println("Example: Description")
    
    // Example code here
    if err := doSomething(); err != nil {
        log.Fatal(err)
    }
    
    fmt.Println("Example completed successfully!")
}

We welcome example contributions! See CONTRIBUTING.md for guidelines.

Examples should:

• Be clear and well-documented
• Demonstrate real-world use cases
• Include error handling
• Be easy to understand and modify