marwa-framework

Marwa Framework Documentation

Welcome to the official documentation for the Marwa Framework.

If you want a complete starter application built on top of this framework, use memran/marwa-php.

Table of Contents

  1. Getting Started
  2. Tutorials
  3. Basics
  4. Console
  5. API Reference
  6. Architecture
  7. Security
  8. Recipes
  9. Developer

Getting Started

New to Marwa? Start here:

Guide Description Time
Getting Started Overview of getting started 1 min
Installation Install and configure 5 min
Quick Start Build your first app 5 min
Project Structure Directory layout 3 min
Configuration App configuration 3 min
Starter Kits Quick project setup 2 min

Starter application:

Tutorials

Step-by-step guides for common tasks:

Tutorial Description
Controllers Handle HTTP requests
Validation Validate user input
Views Twig templates
Models Database models
Database DB management
Modules Modular runtime, manifests, and module menus
Seeding Seed database
Security Security features
Events Event handling
Mail Send emails
Notifications Notifications
HTTP Client HTTP requests
DebugBar Debug toolbar

Basics

Core concepts and features:

Guide Description
Routing Define application routes
Middleware HTTP middleware
Requests Handle incoming requests
Responses Build HTTP responses
CSRF Protection CSRF token handling
Session Session management
Logging Application logging
URL Generation Generate URLs

Console

CLI commands and development:

Guide Description
Console Overview Console commands
Database Commands DB management commands
Custom Commands Create commands

API Reference

Complete API documentation:

Reference Description
Reference Index API overview
Application Application class
Configuration Config reference
Facades Facade reference
Helpers Helper functions
Controllers Controller reference
Middleware Middleware reference
Events Event reference

Architecture

How the framework works:

Guide Description
Architecture Design overview
Boot Flow Bootstrap flow
Design Principles Design decisions
Service Container DI container
Service Providers Service providers

Security

Security features and best practices:

Guide Description
Authentication User authentication
Authorization Access control
Security Best Practices Security checklist

Recipes

Practical guides for common tasks:

Recipe Description
Recipes Index All recipes
Troubleshooting Common issues
Deployment Production deployment
Testing Writing tests

Developer

Notes for contributors:

Guide Description
Console Development CLI development
AI Coding Guide AI-assisted coding

Quick Reference

Installation

composer require memran/marwa-framework
cp .env.example .env

Run Development Server

php -S localhost:8000 -t public

Run Console

php marwa

Run Tests

composer test

Static Analysis

composer stan

Version

Current version: See composer.json

Contributing

Contributions welcome! See GitHub.

Need Help?

  1. Troubleshooting - Common issues
  2. GitHub Issues - Report bugs
  3. GitHub Discussions - Ask questions
This site is open source. Improve this page.