ozi / ozi_script
Ozi script is an easy-to-use web development framework that handles both front-end and back-end web development. It uses a component-based concept, meaning that everything in Ozi script is a component, and a component is a method or function created to handle a specific task.
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=8.0
This package is auto-updated.
Last update: 2025-01-11 12:55:30 UTC
README
🚀 Ozi Script Documentation 🚀
Version: 0.5
Ozi Script is an easy-to-use web development framework that simplifies both front-end and back-end development. It follows modern principles with a component-based architecture, ensuring reusable components for efficient and scalable projects. By adopting the DRY (Don't Repeat Yourself) and KISS (Keep It Simple, Stupid) principles, Ozi Script helps you write clean, maintainable code.
Key Features
✨ Component-Based Architecture: Build reusable, modular components for better scalability and maintainability.
✨ Progressive Web App (PWA) Capabilities: Installable apps, offline support, and access to native device features like push notifications.
✨ Extensibility with Widgets and Plugins: Easily enhance your app with pre-built widgets and plugins.
✨ Easy Setup and Development: Streamlined installation and a simple, intuitive structure.
Installation Guide
Prerequisites:
• XAMPP (or any PHP server)
• Composer
Steps:
-
Verify PHP and Composer installation:
php --version composer --version
-
Install Ozi Script:
composer create-project ozi/ozi_script projectName
-
Navigate to your project folder:
cd projectName
-
Start the development server:
php ozi serve
(For custom port:
php ozi serve 5000
) -
Open in browser:
Default:http://localhost:3000
Custom:http://localhost:5000
🎉 Ozi Script is now installed and ready to go!
Folder Structure Overview
Explore the default folder structure:
projectName/
├── Assets/
├── Components/
├── Cores/
├── Screens/
├── System_files/
├── .htaccess
├── Call_bk_request.php
├── Create_bk_request.php
├── Index.php
├── Manifest.json
├── Offline.html
├── Ozi
├── sw.js
├── System_config.php
├── Ui_config.php
└── View.php
Key Folders:
- Assets/: Media & styling files
- Components/: Screens and reusable components
- Cores/: Back-end logic
- System_files/: Dependencies and essential files
- Manifest.json & sw.js: PWA configuration & offline support
Widgets
What are Widgets?
Reusable UI components, pre-styled and pre-configured. Examples: Floating Action Buttons (FAB) and navbars.
Installing Widgets:
php ozi widget <widget_name> install
Example: To install FAB:
php ozi widget fab install
Using Widgets:
<?php fab(); ?> // Default FAB style <?php fab("param1", "param2"); ?> // Custom FAB style
Plugins
What are Plugins?
Advanced functionalities like API integrations or tools for complex processing.
Installing Plugins:
php ozi plugin <plugin_name> install
Using Plugins:
<?php PluginName("param1", "param2"); ?>
Additional Notes:
🎥 Video tutorials available on the Ozi Script YouTube Channel!
💡 Each widget and plugin comes with documentation and usage examples.
Start building powerful web apps effortlessly with Ozi Script! 💻✨