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:
- README - Platform overview and quick start
- Interface Builder - Visual HTML authoring (not drag-and-drop)
- Code Editor - Writing backend code (works like VSCode)
- Version Control - Branching, diffing, and merging changes
π¦ Import & Export
Bringing Code Into Stellify
-
Importing Laravel Projects - Full Laravel project import
- Using stellify-laravel
- Migrate existing apps to Stellify
- Hybrid development workflows
-
Importing Code - Import individual files and classes
- Stellify Importer tool
- Import from GitHub, Composer, URLs
- Selective file imports
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
- JavaScript Bundling - Modern asset compilation
- Using stellify-bundler-service
- Vite configuration
- Vue, React, Alpine.js integration
- Tailwind CSS setup
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
- Interface Builder Walkthrough - Visual HTML authoring
- Code Editor Tutorial - Coming soon
π External Resources
GitHub Repositories
- stellify-laravel - Laravel project importer
- stellify-bundler-service - JavaScript bundling
- stellify-mcp - AI integration via MCP
Community
- Discord/Slack - Links TBD
- GitHub Issues - Report bugs and feature requests
- Support - Contact via platform
π By Topic
For Beginners
- README - Start here
- Interface Builder - Build UI visually
- Code Editor - Write backend code
- Version Control - Branch and merge safely
- Configuration - Set up services
For Laravel Developers
- Importing Laravel - Bring existing projects
- Code Editor - Familiar Laravel development
- Version Control - Branch and merge changes
- Exporting Code - Deploy as Laravel app
- JavaScript Bundling - Vite integration
For Frontend Developers
- Interface Builder - Visual HTML authoring
- JavaScript Bundling - Modern JS/CSS
- Exporting Code - Get production files
For AI Enthusiasts
- Optimal Method Patterns - How AI composes code
- MCP & AI Setup - AI integration
- Code Editor - Understand code structure
- Importing Code - Bring AI-generated code
π― Common Tasks
Building a New App
- Create project in Stellify
- Configure database
- Build interface - Design pages
- Write code - Add backend logic
- Use branches - Safely experiment with changes
- Bundle assets - Compile JS/CSS
- Export and deploy
Migrating Existing Laravel App
- Import Laravel project
- Configure in Stellify platform
- Continue development in Stellify
- Export back to Laravel
- Deploy as usual
Adding AI to Your Workflow
- Set up MCP
- Connect Claude Desktop/Code
- Use AI for code generation
- Review and test AI changes
- 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?
- Open an issue on GitHub
- Submit a pull request
- 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!
- Next
- Interface Builder