README

Welcome to UponWord, a powerful and flexible framework designed to streamline the development of WordPress themes. Whether you're a seasoned developer or just getting started, UponWord provides the tools and structure you need to create high-quality, maintainable themes with ease.

Table of Contents

• Features
• Getting Started
• Installation
• Usage
• Configuration
• License
• Contact

Features

• Modular Architecture: Organize your code with a clean, modular structure.
• Custom Helper Functions: Simplify common tasks with reusable helper functions.
• Template Enhancements: Pre-configured template parts for rapid development.
• Customizable Theme Options: Easily configure theme settings and options.
• Composer Integration: Manage dependencies with Composer.
• Developer Tools: Built-in debugging and optimization utilities.

Getting Started

To get started with UponWord, follow these steps to set up your development environment.

Prerequisites

• WordPress installation (minimum version 6.4)
• PHP (minimum version 8.2)
• Composer (for dependency management)

Installation

You can install UponWord by cloning the repository or via Composer.

Cloning the Repository

git clone https://github.com/navidnasro/upon-word.git

Activate the theme through the WordPress admin dashboard.

Composer Installation

{
    "require": {
        "navidnasro/upon-word": "1.0.0"
    }
}

Run composer install to download and install the dependencies.

Usage

UponWord provides a robust foundation for your WordPress themes. Here's a quick overview of how to use its core features.

Theme Setup

most of your configuration process take place in ThemeInitializer.php class

public function enqueueFiles(): void{} // to require all necessary assets (js,CSS,..)
public function themeSetup(): void{} // to configure after theme setup operations

and with custom code which brightens your way to know how to use them ,some may be what you were already looking for :)

Helper Functions

Cookie::set('custom','custome_value',60*60*3); // by simply calling a method, you created a secure and encrypted cookie that lasts 3 hours

Spam::checkForSpam() // you just easily secured your requests and found whether the user is sending spam requests or not. if so they will be banned for some time :D

Modular Template Structure

DemoFactory::getDemoFactory(); // DemoFactory lets you build you website with multiple demos and change between demos with a blink of an eye!!!!!

Configuration

visiting enums/Constants and enums/Defaults is all you need for configuration

License

UponWord is open-sourced software licensed under the GNU General Public License v3.0 (GPL-3.0).

Contact

For any questions or feedback, feel free to reach out:

• Email: navidnasro13@gmail.com
• GitHub: navidnasro
• LinkedIn: navidnasro