Skip to content

Latest commit

 

History

History

README.md

DevStream Tutorials

Comprehensive step-by-step tutorials for learning DevStream from beginner to advanced workflows.

Tutorial Overview

Tutorial Time Difficulty Description
Your First DevStream Project ~45 min Beginner Create a new FastAPI project from scratch with DevStream integration
Adding DevStream to Existing Project ~60 min Intermediate Integrate DevStream into an existing Flask application
Creating a Custom Agent ~50 min Advanced Build a Flask specialist agent from scratch
Multi-Stack Workflow ~75 min Advanced Build full-stack feature with agent orchestration

Learning Path

For New Users

Start here → Your First DevStream Project

This tutorial covers:

  • DevStream setup and configuration
  • Task lifecycle management
  • Semantic memory system
  • Context7 integration
  • Quality standards (95%+ test coverage)

Time: 45 minutes | Outcome: Production-ready FastAPI CRUD API


For Existing Projects

Start here → Adding DevStream to Existing Project

This tutorial covers:

  • Project compatibility assessment
  • Non-disruptive installation
  • Codebase scanning for memory population
  • Creating intervention plans
  • Incremental improvement workflow

Time: 60 minutes | Outcome: DevStream-enhanced existing project with 99% test coverage


For Advanced Customization

Prerequisites: Complete "Your First DevStream Project"

Next → Creating a Custom Agent

This tutorial covers:

  • Agent architecture (4-level hierarchy)
  • Agent design and capabilities
  • Configuration file format
  • Testing and validation
  • Production integration

Time: 50 minutes | Outcome: Custom Flask specialist agent ready for production


For Full-Stack Development

Prerequisites: Complete "Your First DevStream Project" + understanding of React/TypeScript

Next → Multi-Stack Workflow

This tutorial covers:

  • Multi-agent orchestration with @tech-lead
  • Backend implementation (@python-specialist)
  • Frontend implementation (@typescript-specialist)
  • Integration coordination (CORS, authentication)
  • Quality validation (@code-reviewer)

Time: 75 minutes | Outcome: Production-ready full-stack user management dashboard


Tutorial Features

All tutorials follow the Diátaxis framework (learning-oriented approach) and include:

✅ Clear Learning Objectives: What you'll learn and why it matters ✅ Prerequisites Checklist: Required tools, knowledge, and verification commands ✅ Step-by-Step Instructions: Numbered steps with copy-paste ready commands ✅ Expected Outputs: What you should see after each step ✅ Verification Checkpoints: Validate progress throughout the tutorial ✅ Real Code Examples: Working examples from DevStream development ✅ Troubleshooting Sections: Common issues and solutions inline ✅ Learning Summaries: Key concepts and takeaways ✅ Next Steps: Related tutorials and advanced topics


Tutorial Structure

Each tutorial follows this structure:

1. Introduction

  • What You'll Learn: Learning objectives
  • Time: Estimated completion time
  • Difficulty: Beginner/Intermediate/Advanced
  • Prerequisites: Required knowledge and tools

2. What We'll Build

  • Clear description of the end result
  • Architecture overview
  • Key features

3. Step-by-Step Walkthrough

  • Numbered steps with clear objectives
  • Copy-paste ready commands
  • Expected outputs
  • Verification checkpoints

4. What You Learned

  • Summary of concepts covered
  • Key takeaways
  • Skills acquired

5. Next Steps

  • Immediate actions
  • Advanced topics
  • Related tutorials and documentation

6. Troubleshooting

  • Common issues specific to the tutorial
  • Solutions with commands
  • Verification steps

Quick Reference

Tutorial Outcomes

First Project:

  • ✅ FastAPI CRUD API
  • ✅ 97% test coverage
  • ✅ Semantic memory (15+ records)
  • ✅ Context7 integration

Existing Project:

  • ✅ Non-disruptive DevStream integration
  • ✅ Codebase scan (47 patterns)
  • ✅ Test coverage improvement (87% → 99%)
  • ✅ Security hardening (rate limiting)

Custom Agent:

  • ✅ Flask specialist agent
  • ✅ Full tool access
  • ✅ Context7 integration
  • ✅ Production-ready configuration

Multi-Stack Workflow:

  • ✅ FastAPI backend (96% coverage)
  • ✅ React TypeScript frontend (97% coverage)
  • ✅ Full-stack integration (CORS, JWT auth)
  • ✅ Quality validation (OWASP, performance)

Common Patterns Across Tutorials

DevStream Workflow (7 Steps)

All tutorials follow the mandatory DevStream workflow:

  1. DISCUSSIONE: Define goals and acceptance criteria
  2. ANALISI: Analyze requirements and codebase
  3. RICERCA: Use Context7 for research-driven development
  4. PIANIFICAZIONE: Create task list (TodoWrite for complex tasks)
  5. APPROVAZIONE: Get explicit approval before implementation
  6. IMPLEMENTAZIONE: Execute one micro-task at a time
  7. VERIFICA/TEST: Validate with 95%+ test coverage

Quality Standards

All tutorials enforce DevStream quality standards:

  • ✅ Test Coverage: 95%+ for new code
  • ✅ Type Safety: Full type hints (Python) or strict TypeScript
  • ✅ Security: OWASP awareness, input validation
  • ✅ Documentation: Docstrings, inline comments
  • ✅ Performance: Profiling and optimization

Automatic Systems

All tutorials demonstrate DevStream's automatic features:

  • 🤖 Semantic Memory: PostToolUse hook stores code automatically
  • 🤖 Context Injection: PreToolUse hook retrieves relevant context
  • 🤖 Context7 Integration: Library documentation auto-injected
  • 🤖 Quality Gates: @code-reviewer validation before commits

Getting Help

Before Starting

  1. Check Prerequisites: Verify all required tools installed
  2. Read Introduction: Understand learning objectives and outcomes
  3. Clone DevStream: Have DevStream repository available for reference

During Tutorial

  1. Follow Checkpoints: Verify progress at each checkpoint
  2. Copy Commands Exactly: Use provided commands as-is
  3. Check Expected Outputs: Compare your results with tutorial outputs
  4. Use Troubleshooting: Check troubleshooting section for common issues

After Completion

  1. Review Learning Summary: Consolidate what you learned
  2. Try Next Steps: Experiment with suggested actions
  3. Explore Related Docs: Deep dive into specific topics

Contributing

Found an issue or have a suggestion?

  1. Issues: Report problems in DevStream issue tracker
  2. Improvements: Suggest tutorial enhancements
  3. New Tutorials: Propose additional tutorial topics

Related Documentation

User Guides

Developer Guides

How-To Guides


Tutorial Collection Version: 1.0.0 Last Updated: 2025-10-01 Total Tutorials: 4 Total Learning Time: ~230 minutes (3.8 hours)