Skip to main content

Quickstart

Prerequisites

  • N8N instance (self-hosted or cloud)
  • GitHub Personal Access Token with repo scope
  • Anthropic or OpenAI API key

Installation

# Clone the repository
git clone https://github.com/so1-io/flashcard-assistant.git
cd flashcard-assistant

# Set up Python environment
./scripts/setup.sh

# Deploy workflow to N8N
./scripts/deploy_workflow.sh

Generate Your First Flashcards

curl -X POST https://your-n8n.com/webhook/flashy-generate \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "repos": [{
      "url": "https://github.com/your-org/your-repo",
      "branch": "main"
    }],
    "model": "claude-3.5-sonnet",
    "cost_limit_usd": 10.0,
    "atlas_enabled": true,
    "notification_email": "you@example.com"
  }'

Output Structure

Generated flashcards are organized by category:
docs/cards/
├── README.md                    # Navigation index
├── architecture/
│   ├── [Repo] - Architecture - System Overview.md
│   └── [Repo] - Architecture - Design Patterns.md
├── infrastructure/
│   ├── [Repo] - Infrastructure - Deployment.md
│   └── [Repo] - Infrastructure - Resilience.md
├── performance/
├── security/
└── integration/

Next Steps

Source Reference

This documentation is derived from README.md and docs/QUICKSTART.md.