README.md

OpenBazaar AI Documentation

Complete documentation for deploying, configuring, and extending OpenBazaar AI.

---

Current Reality

Updated: March 13, 2026

This docs index keeps the richer original structure, but the current truth is:

• the repo has a broad implemented feature surface
• the automated suite is green (40 suites, 517 tests passing)
• the prompt-to-working-store gap is now closed: creator dashboard, store product checkout, live buttons in rendered stores, course/funnel generation open to users
• several high-value flows are implemented but still need production validation

Canonical truth sources:

• reference/MARKETPLACE_STATUS_AND_TODO.md
• ROADMAP.md
• ../CHANGELOG.md

Use those first when a feature doc and the code appear to disagree.

---

Quick Navigation

New to OpenBazaar AI?

1. Quick Start Guide - Deploy your first node in 48 hours
2. Core Architecture - Understand the dual-mode system
3. Quick Deploy - Fastest deployment path
4. Current Status - What is working, partial, blocked, and next

Setting Up Your Node

• Deployment Overview - Production deployment guide
• Production Setup - Detailed production checklist
• Docker Deployment - Containerized deployment
• Censorship-Resistant Setup - Offshore and failover configuration

Configuring Features

• Authentication Setup - Local auth or TENEO Auth SSO
• Stripe Integration - Payment processing setup
• Security Hardening - Complete security checklist
• Operator Guide - Managed AI store-build workflow

---

Documentation Structure

quick-start/

Fast-track guides for getting started quickly

• MVP 48-hour launch guide
• Quick deploy scripts
• Minimal configuration paths

core/

Core architecture and design principles

• Dual-Mode Architecture - Primary + fallback modes
• Implementation Map - System component overview
• Interface Specification - API contracts

features/

Feature guides and implementation details

• Course Platform Design - Course architecture
• Course Implementation - Course platform details
• Course Player - Player UI
• Book Funnel Blueprint - Funnel system
• Funnel Builder Concept - Builder architecture
• Funnel Integration Plan - Integration strategy
• Email Marketing - Marketing automation
• Podia Feature Parity - Competitive analysis
• Information Asymmetry brand notes
• Amazon integration and published books tracking
• Multi-channel sales strategies
• Brand automation roadmap

deployment/

Production deployment and infrastructure

• Production Setup
• Production Deployment - Production guide
• Censorship-Resistant MVP
• Render Deployment - Deploy to Render
• Docker deployment
• Stripe production configuration
• Deployment status and checklists

integration/

Third-party integrations and OAuth setup

• Authentication Setup - Local vs TENEO Auth
• TENEO Auth Integration - SSO strategy
• Orchestrator integration
• Webhook configuration
• ClickFunnels integration

development/

Contributing and extending the platform

• Contributing Guide
• AI Builder Strategy - Build with Claude Code
• AI Store Builder Checklist - Execution companion
• Self-Serve Store + Funnel Beta Checklist - Concrete launch checklist for normal users

legal/

Brand protection and legal operations

• Trademark Filing Automation - Filing packets and docket workflow

reference/

Technical reference and specifications

• Marketplace Status - Canonical current state
• Best Practices Audit - Repo-wide compliance audit against TE Code guidance
• Security Setup Guide - Deployment hardening
• Security Audit Report - Security review
• Open Source Assessment - Project evaluation
• Documentation Map - Complete doc navigation
• Auth Integration Complete - Auth system docs
• Course Module Cleanup - Cleanup summary
• Course Migration Guide - Migration docs
• Funnel Infrastructure Audit - Funnel audit
• Implementation Plan - Historical planning context
• Marketplace vs Production Strategy - Repo strategy
• Cost tracking architecture
• Public vs private strategy
• Archives - Historical documentation

---

Role-Based Reading Paths

For Node Operators

Goal: Deploy and run a marketplace node

1. Current Status
2. Quick Start Guide
3. Authentication Setup
4. Security Hardening
5. Production Deployment

For Developers

Goal: Contribute code or build custom features

1. Current Status
2. Roadmap
3. Core Architecture
4. Implementation Map
5. Contributing Guide
6. AI Builder Strategy

For Operators of the AI Store Builder

Goal: Run paid or internal store builds cleanly

1. Operator Guide
2. AI Store Builder Checklist
3. Roadmap

For Shipping Self-Serve Store Beta

Goal: Let normal users create hosted stores and funnels without manual intervention

1. Current Status
2. Roadmap
3. Self-Serve Store + Funnel Beta Checklist
4. AI Store Builder Checklist

For Security Auditors

Goal: Assess platform security

1. Current Status
2. Security Setup Guide
3. Authentication Architecture
4. Deployment Security

---

Priority Documentation

Essential

• Marketplace Status - Current truth source
• Roadmap - Canonical phased plan
• Dual-Mode Architecture - Core system design
• Authentication Setup - User authentication

Important

• Production Deployment - Production setup
• Security Setup Guide - Deployment hardening
• Operator Guide - Managed store-build execution

Helpful

• Quick Deploy - Fastest deployment
• Implementation Map - Code navigation
• TENEO Auth Integration - SSO details

---

Quick Reference Cards

Common Commands

# Start marketplace
npm start

# Dev server
npm run dev

# Full test run
npm test -- --runInBand

# Initialize database
node marketplace/backend/database/init.js

# Generate admin password
node marketplace/backend/scripts/generate-password-hash.js "YourPassword"

# Deploy with Docker
docker-compose up -d

Configuration Files

• .env - Environment configuration (never commit to git)
• .env.example - Template for environment variables
• marketplace/backend/database/schema.sql - Database structure
• marketplace/frontend/brands/*/config.json - Brand configurations

---

Documentation Governance

This repo now follows the documentation-related parts of C:\code\.claude\BEST_PRACTICES.md more explicitly:

• canonical roadmap: ROADMAP.md
• canonical current-state doc: reference/MARKETPLACE_STATUS_AND_TODO.md
• best-practices audit: reference/BEST_PRACTICES_AUDIT.md
• changelog at repo root: ../CHANGELOG.md
• docs index acts as a stable discovery layer instead of competing with the truth docs

When project state changes, keep these files aligned:

• README.md
• docs/README.md
• docs/ROADMAP.md
• docs/reference/MARKETPLACE_STATUS_AND_TODO.md
• CHANGELOG.md

---

Additional Resources

Official Documentation

• Main README - Project overview
• CLAUDE.md - Claude Code integration guide

External Resources

• Stripe Docs: https://stripe.com/docs
• SQLite Docs: https://sqlite.org/docs.html
• Docker Docs: https://docs.docker.com/

Community

• GitHub Issues: Report bugs and request features
• GitHub Discussions: Ask questions and share ideas

---

Documentation Standards

All documentation in this repository should follow these standards:

• Markdown with clear headings
• Accurate status labeling: implemented, partial, beta, planned, blocked
• Evidence-backed roadmap updates
• No content loss when trimming or reorganizing docs
• Cross-links to the canonical truth docs

---

Contributing to Documentation

Found an error or want to improve the docs? See Contributing Guide.

Documentation contributions welcome:

• Fix typos and errors
• Add missing examples
• Improve clarity
• Add diagrams and visuals
• Keep docs aligned with the actual code and verification state

---

Last Updated: March 13, 2026

Need help? Start with the current status doc and roadmap, then branch into the feature or deployment guide you need.