Getting Started with Jankx Theme

Welcome to Jankx Theme! This guide will help you get up and running quickly.

Installation

Method 1: Via Composer (Recommended)

composer require jankx/jankx

Method 2: Manual Installation

1. Download the latest release from GitHub Releases
2. Extract to /wp-content/themes/jankx/
3. Activate in WordPress Admin → Appearance → Themes

Method 3: Git Clone

cd /wp-content/themes/
git clone https://github.com/jankx/jankx-lite.git jankx

Requirements

Configuration

Environment Setup

Create .env file in theme root:

# Development Mode
JANKX_ENV=development
JANKX_DEBUG=true

# Cache Settings
JANKX_CACHE_ENABLED=false

# API Keys (optional)
GOOGLE_FONTS_API_KEY=your_key_here

Theme Configuration

Edit config/app.php:

return [
    'providers' => [
        // Service Providers
        \Jankx\Support\Providers\ContentLayoutServiceProvider::class,
        \Jankx\Admin\Providers\AdminServiceProvider::class,
    ],
    'options' => [
        'framework' => 'jankx',
    ],
];

First Steps

1. Install Dependencies

composer install
npm install

2. Build Assets

# Development
npm run dev

# Production
npm run build

3. Run Tests

./vendor/bin/phpunit

4. Activate Theme

Go to WordPress Admin → Appearance → Themes → Activate Jankx

Next Steps

• Learn about the Layout System
• Create Custom Extensions

Troubleshooting

Issue: Class not found errors

# Solution: Regenerate autoload
composer dump-autoload

Issue: Styles not loading

# Solution: Rebuild assets
npm run build

Issue: Permission denied on cache

# Solution: Fix permissions
chmod -R 755 wp-content/themes/jankx/cache/

← Back to Documentation