Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
154 lines (112 loc) · 3.49 KB

DOCUMENTATION.md

File metadata and controls

154 lines (112 loc) · 3.49 KB

EasyAPP Framework Documentation

Version: 2.0
Author: YoYo
Copyright: 2022-2025, script-php.ro
License: GPL v3

Table of Contents

Getting Started

Core Concepts

MVC Components

Additional Components

Routing

Database

Advanced Topics

Development Tools

API Reference

Quick Links

Documentation Conventions

Throughout this documentation, you will encounter several conventions:

Code Blocks:

// PHP code examples are shown in code blocks
$example = "value";

File Paths:

  • Absolute paths are shown from project root
  • Example: app/controller/home.php

Placeholders:

  • Items in angle brackets should be replaced
  • Example: <YourClassName> becomes UserController

Notes:

Note: Important information that requires attention

Warnings:

Warning: Critical information about potential issues

Prerequisites

Before using EasyAPP Framework, ensure your environment meets these requirements:

  • PHP Version: 7.4 or higher
  • Extensions:
    • PDO (for database functionality)
    • JSON
    • MBString (recommended)
  • Web Server:
    • Apache with mod_rewrite, or
    • Nginx with proper configuration
  • Composer: Optional, for dependency management

Framework Philosophy

EasyAPP is designed with the following principles:

  1. Simplicity First: Easy to learn and use
  2. Performance: Lightweight and fast execution
  3. Flexibility: Adapt to various project needs
  4. Modern Features: Contemporary PHP practices
  5. Minimal Dependencies: Self-contained framework

Support

If you need assistance:

  1. Check the documentation sections listed above
  2. Review example code in the repository
  3. Visit the GitHub Issues page
  4. Contact the development team

License

EasyAPP Framework is open-source software licensed under the GPL v3 License.

Copyright (c) 2022-2025, script-php.ro

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License.

Next: Installation and Setup