README

What is Jengo PHP?

Jengo PHP is a powerful, production-ready application starter that extends the CodeIgniter 4 framework. It bridges the gap between classic PHP development and modern frontend tooling, providing a seamless experience for building full-stack web applications.

By combining the lightweight, high-performance nature of CodeIgniter 4 with modern frontend capabilities, Jengo PHP allows you to build robust applications with speed and efficiency.

Key Features

• Extends CodeIgniter 4: Retains all standard CI4 functionality while adding powerful new tools.
• Modern Frontend Integration: Native support for Inertia.js with Vue, React, and Svelte.
• Rapid Development: Includes specialized CLI commands to generate code and configure your environment.
• Vite Integration: Comes pre-configured with Vite for lightning-fast frontend builds.

Installation

Create a new Jengo project using Composer:

composer create-project jengo/appstarter my-app

Then, navigate into your project directory:

cd my-app

Setup Frontend with Inertia.js

To set up your modern frontend stack, Jengo provides an interactive installer. Run the following command:

php spark jengo:install inertia

Installation Steps

The installer will guide you through the setup process:

1. Select Framework: Choose your preferred frontend framework:
   • Vue
   • React
   • Svelte
2. Client Directory: Specify where your frontend source files should reside (e.g., app/Client).
3. Dependencies: Jengo will automatically install the necessary NPM packages for you.
4. Home Controller: Update the default Home Controller to use Inertia rendering.

Post-Installation

After the installer completes, you can start your development servers(ensure to set the env file and set CI_ENVIRONMENT to development):

# Terminal 1: Start the PHP development server
php spark serve

# Terminal 2: Start the Vite development server
npm run dev

Visit http://localhost:8080 to see your Jengo application in action!

Deployment

When you are ready to deploy, build your frontend assets for production:

npm run build

Then deploy your PHP application as you would any standard CodeIgniter 4 project.

Resources

• Jengo PHP Documentation
• CodeIgniter 4 User Guide
• Inertia.js Documentation