Getting started

Documentation Contents

Stellify Documentation Index

Complete documentation for building applications with Stellify.

πŸ’‘ Why Stellify is Different

Stellify is a convergence between AI and existing code - enabling AI to operate at a higher architectural level by composing proven, battle-tested components rather than regenerating solutions from scratch.

Key Benefits:

  • AI focuses on architecture, not implementation
  • Zero hallucination on proven code
  • Collective refinement makes code better over time
  • Each project contributes to shared wisdom
  • Build more reliably with less effort

Learn more: README - Core Philosophy

πŸš€ Getting Started

New to Stellify? Start here:

  1. README - Platform overview and quick start
  2. Interface Builder - Visual HTML authoring (not drag-and-drop)
  3. Code Editor - Writing backend code (works like VSCode)
  4. Version Control - Branching, diffing, and merging changes

πŸ“¦ Import & Export

Bringing Code Into Stellify

Getting Code Out of Stellify

  • Exporting Code - Generate production-ready files
    • Export formats and options
    • Deployment workflows
    • CI/CD integration

πŸ› οΈ Advanced Topics

Version Control

  • Version Control - Work with branches safely
    • Creating and switching branches
    • Viewing diffs between branches
    • Merging changes to main
    • Discarding unwanted changes
    • Copy-on-write efficiency

Frontend Development

AI-Assisted Development

  • MCP & AI Setup - Work with AI assistants
    • Using stellify-mcp
    • Claude Desktop integration
    • AI workflows and examples
    • Code generation and debugging

Configuration

  • Configuration Management - Managing app settings (In progress)
    • Database configuration
    • Filesystem setup (S3, local)
    • Custom config profiles

πŸ€– AI Composition

Understanding how AI creates code through Stellify:

  • Optimal Method Patterns - How AI composes methods
    • The composition model (Method β†’ Statement β†’ Clause)
    • Predefined tokens and value clauses
    • Deduplication and reuse strategies
    • Framework-agnostic assembly

This is the foundation for AI convergence with web frameworks - AI operates at the structural level, and Stellify handles mapping to any target.

πŸ“š Reference

Core Concepts

  • Projects - Container for your application
  • Routes - Pages and API endpoints
  • Elements - UI components (stored in database)
  • Files - Controllers, Models, Classes
  • Methods - Functions and logic
  • Statements - Code as structured data (see Optimal Method Patterns)

API Documentation

  • Element System - UI component structure (See ELEMENTS_V2_COMPARISON_GUIDE.md)
  • Config System - JSON-based configuration
  • Code Structure - How code is stored

πŸŽ₯ Video Tutorials

πŸ”— External Resources

GitHub Repositories

Community

  • Discord/Slack - Links TBD
  • GitHub Issues - Report bugs and feature requests
  • Support - Contact via platform

πŸ“– By Topic

For Beginners

  1. README - Start here
  2. Interface Builder - Build UI visually
  3. Code Editor - Write backend code
  4. Version Control - Branch and merge safely
  5. Configuration - Set up services

For Laravel Developers

  1. Importing Laravel - Bring existing projects
  2. Code Editor - Familiar Laravel development
  3. Version Control - Branch and merge changes
  4. Exporting Code - Deploy as Laravel app
  5. JavaScript Bundling - Vite integration

For Frontend Developers

  1. Interface Builder - Visual HTML authoring
  2. JavaScript Bundling - Modern JS/CSS
  3. Exporting Code - Get production files

For AI Enthusiasts

  1. Optimal Method Patterns - How AI composes code
  2. MCP & AI Setup - AI integration
  3. Code Editor - Understand code structure
  4. Importing Code - Bring AI-generated code

🎯 Common Tasks

Building a New App

  1. Create project in Stellify
  2. Configure database
  3. Build interface - Design pages
  4. Write code - Add backend logic
  5. Use branches - Safely experiment with changes
  6. Bundle assets - Compile JS/CSS
  7. Export and deploy

Migrating Existing Laravel App

  1. Import Laravel project
  2. Configure in Stellify platform
  3. Continue development in Stellify
  4. Export back to Laravel
  5. Deploy as usual

Adding AI to Your Workflow

  1. Set up MCP
  2. Connect Claude Desktop/Code
  3. Use AI for code generation
  4. Review and test AI changes
  5. Export and deploy

πŸ’‘ Tips & Best Practices

Interface Builder

  • Use semantic HTML tags (header, nav, section)
  • Leverage Tailwind CSS utilities
  • Test responsive designs
  • Keep structure logical

Code Editor

  • Follow PSR-12 standards
  • Write descriptive method names
  • Add comments for complex logic
  • Validate all user input

Import/Export

  • Test imported code in Stellify
  • Use dry-run before overwriting
  • Version control your exports
  • Keep dependencies updated

JavaScript Bundling

  • Code split by route
  • Lazy load components
  • Optimize images
  • Use tree-shaking

AI Integration

  • Be specific in prompts
  • Always review AI changes
  • Test thoroughly
  • Learn from AI explanations

πŸ†˜ Getting Help

Documentation

  • Read the relevant guide above
  • Check video tutorials
  • Review examples in docs

Support Channels

  • GitHub Issues - Bug reports and features
  • Discord/Slack - Community support
  • Email - Direct support contact

Common Issues

Check troubleshooting sections in:

πŸ“ Contributing

Found an error or want to improve documentation?

  1. Open an issue on GitHub
  2. Submit a pull request
  3. Contact support

πŸ—ΊοΈ Roadmap

Upcoming documentation:

  • Configuration Guide (in progress)
  • API Reference
  • Deployment Guide
  • Testing Guide
  • Performance Optimization
  • Security Best Practices

Ready to build? Start with the README or jump to Interface Builder to begin creating your app!

Please be aware that our documentation is under construction.