Cleaf Framework

Cleaf is a lightweight, open-source PHP web framework designed to simplify web development while maintaining flexibility and power. Developed and maintained by Satriyo, Cleaf offers an intuitive structure that makes it an excellent choice for both beginners and experienced developers.

Features

• Lightweight: Cleaf is designed to be fast and efficient, with minimal overhead.
• PSR Compliant: Implements PSR-4 for autoloading.
• Easy to Learn: Simple structure and clear documentation make it easy for newcomers to get started.
• Flexible: Suitable for small web applications to large-scale projects.
• Open Source: All source code is publicly available on GitHub.
• Community-Sourced: Cleaf is developed by the community and maintained by the community.
• Easy To Use: Cleaf is designed to be easy to use and understand.
• Extensible: Cleaf is extensible and can be easily customized to meet the needs of your application.
• Modular: Cleaf is modular and can be easily extended to add new functionality.
• Reliable: Cleaf is reliable and provides a robust and reliable development experience.
• TailwindCSS Compatible: Cleaf is compatible with the TailwindCSS framework.

Getting Started

Prerequisites

• PHP 8.0 or higher
• Composer (for dependency management)
• Git
• Node.js or NPM

Installation

1. Clone the repository:

   git clone https://github.com/satrijo/Cleaf.git

2. Navigate to the project directory:

   cd Cleaf

3. Install dependencies:

   composer install
   npm install

Running the Application

To start the built-in PHP development server:

npm run dev

You can now access your Cleaf application at http://localhost:9899 .

Contributing

We welcome contributions from the community! Here are ways you can contribute:

1. Submitting Issues: Report bugs or suggest features on our GitHub Issues page.
2. Improving Documentation: Help us improve our documentation to make Cleaf more accessible.
3. Writing Code: Submit pull requests with bug fixes, new features, or improvements.

Please read our Contributing Guidelines before making a contribution.

Support

If you'd like to support the project financially, you can make a donation to help sustain development and cover project-related costs. Your contributions enable us to continue delivering new features and updates to Cleaf.

Donate to Cleaf

License

Cleaf is open-source software licensed under the MIT license. See the LICENSE file for more details.

Contact

For questions, suggestions, or support, please reach out to Satriyo:

• GitHub: @satrijo
• Email: [email protected]

---

Thank you for choosing Cleaf Framework. We hope it empowers you to build amazing web applications!