README

Boilerplate project to scaffold a new SplitPHP application.

Installation

You can get started in two ways:

1. Via Composer

composer create-project splitphp/starter myapp
cd myapp

This will install the splitphp/core engine and set up the basic directory structure.

2. Download ZIP (For non-composer users)

Go to the Releases page.
Download the splitphp-distribution-<version>.zip asset.

Extract it:

unzip splitphp-distribution-<version>.zip -d myapp
cd myapp

Directory Structure

myapp/
├── core/         # SplitPHP core framework
├── application/  # Application-specific code (user-defined code)
├── modules/      # Reusable scalable modules (user-defined code)
├── public/       # Web entry-point (e.g. index.php)
├── config.ini    # Configurations file
└── README.md     # This file
└── LICENSE       # MIT License file
└── console       # CLI entry-point

Getting Started

Setup your application:

php console setup

This will create your application hash keys and config.ini file from example.config.ini, so you don't have to rename it manually.

Run your application's dev server:

php console server:start

This will create your application hash keys and config.ini file from example.config.ini, so you don't have to rename it manually.

Access http://localhost:8000 in the browser and you shall see the SPLIT PHP Welcome Page.

Documentation

For a more complete documentation, usage examples, and advanced topics, see the SplitPHP Core repository README.

splitphp / starter

Maintainers

Details