Skip to content

README.md

Latest commit

 

History

History
57 lines (40 loc) · 2.65 KB

README.md

File metadata and controls

57 lines (40 loc) · 2.65 KB

🏗️ Craftile PHP

PHP integration for the Craftile visual editor - Build dynamic, block-based layouts with seamless editor integration.

Latest Version PHP Version License

Craftile PHP provides the server-side foundation for integrating with the Craftile Visual Editor, enabling you to build dynamic, block-based content management systems with Laravel.

✨ Features

  • 🎨 Visual Block Editor Integration - Seamlessly connect with Craftile's drag-and-drop editor
  • 🔧 Laravel-First Design - Built specifically for Laravel applications with service providers and facades
  • 📦 Block-Based Architecture - Create reusable content blocks with properties and validation
  • 🎯 Template Compilation - Transform JSON/YAML templates into optimized Blade views
  • 🚀 Performance Optimized - Intelligent caching and lazy loading for production use
  • 🔍 Developer Friendly - Comprehensive testing, static analysis, and clear documentation

🔌 Official Packages

This monorepo contains:

  • craftile/core - Core block functionality and data structures
  • craftile/laravel - Laravel integration with service providers and Blade directives

📁 Project Structure

packages/
├── core/           # Core functionality (framework-agnostic)
│   ├── src/        # Block schemas, data structures, services
│   └── tests/      # Unit tests
└── laravel/        # Laravel integration
    ├── src/        # Service providers, compilers, facades
    ├── config/     # Configuration files
    ├── resources/  # Blade templates and views
    └── tests/      # Integration tests

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

Craftile PHP is open-sourced software licensed under the MIT license.

Ready to build something amazing? Check out the Craftile Editor to see the visual editing experience in action! 🚀