Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

Behflow Documentation

Welcome to the comprehensive documentation for Behflow - an AI-powered, self-hosted task management system.

Repository: https://github.com/artaasd95/Behflow

📑 Documentation Index

Core Documentation

Document Description
Architecture Complete system architecture, components, and design principles
API Documentation REST API endpoints with examples and response formats
Agent System AI agent internals, tools, and LangGraph implementation
Database Schema Database models, relationships, and services
Frontend Guide UI architecture, state management, and components

Integration & Deployment

Document Description
Integration Guide External service integrations (Slack, Calendar, Jira, etc.)
Deployment Guide Docker, Kubernetes, cloud platform deployment strategies
Configuration Environment variables, feature flags, and settings

Development

Document Description
Testing Guide Unit tests, integration tests, coverage requirements
Automated Processes Background task scheduling and automation
Changes & Tasks Version history and development roadmap

🚀 Quick Links

📖 Reading Guide

For New Users

  1. Start with Architecture for system overview
  2. Read API Documentation for API usage
  3. Check Frontend Guide for UI details

For Developers

  1. Review Architecture for design principles
  2. Study Agent System for AI implementation
  3. Read Database Schema for data models
  4. Follow Testing Guide for test practices
  5. See Configuration for setup options

For DevOps

  1. Check Deployment Guide for infrastructure
  2. Review Configuration for environment setup
  3. See Automated Processes for background jobs

For Integration

  1. Read Integration Guide for external services
  2. Check API Documentation for API endpoints
  3. Review Configuration for webhook setup

🏗 System Overview

Behflow = Frontend (UI) + Backend (API) + Agent (AI) + Database (PostgreSQL)
  • Frontend: Vanilla JS single-page application
  • Backend: FastAPI REST API with business logic
  • Agent: LangGraph-powered AI task orchestration
  • Database: PostgreSQL with SQLAlchemy ORM

🔧 Tech Stack

  • Languages: Python 3.11+, JavaScript (ES6+)
  • Frameworks: FastAPI, LangGraph, LangChain
  • Database: PostgreSQL 15+
  • LLM: OpenAI GPT-4 / Anthropic Claude
  • Infrastructure: Docker, Kubernetes
  • Testing: pytest, Jest

📝 Documentation Standards

All documentation follows these principles:

  1. Clear Structure: Hierarchical organization with headings
  2. Code Examples: Real, runnable code snippets
  3. Diagrams: Visual representations where helpful
  4. Up-to-Date: Synchronized with codebase changes
  5. Searchable: Descriptive titles and comprehensive content

🤝 Contributing to Docs

When adding new features:

  1. Update relevant documentation files
  2. Add code examples and usage patterns
  3. Update architecture diagrams if needed
  4. Add entries to this README index
  5. Keep documentation synchronized with code

📚 Additional Resources

Recent Changes

  • 2025-12-18: Completed comprehensive documentation suite
  • 2025-12-18: Added testing guide and unit tests
  • 2025-12-18: Created integration and deployment guides
  • 2025-12-18: Documented agent system and database schema
  • 2025-12-18: Expanded architecture with diagrams and patterns

For questions or clarifications, please open an issue on GitHub.