Installation

Requirements

Before installing Cresenity Framework, make sure your environment meets the following requirements:

  • PHP >= 7.4
  • Composer (globally installed)
  • Git
  • Apache with mod_rewrite enabled (or Nginx equivalent)

For a full list of required PHP extensions, see Configuration.

Install the phpcf CLI Tool

The phpcf command-line tool is used to create and manage Cresenity applications.

composer global require cresenity/phpcf

Make sure the Composer global vendor/bin directory is in your system PATH. You can verify the installation by running:

phpcf --version

Clone the Framework

git clone git@github.com:cresenity/cf.git
cd cf

After cloning, copy the sample entry point to create your index.php:

cp index.php.sample index.php

Set Up an Existing Project

If you are working on an existing project, clone its repository into the application/ directory:

cd application
git clone git@github.com:your-org/myproject.git

This will create the structure application/myproject/.

Create a New Project

To scaffold a new application, first create the app's directory under application/, then run phpcf init from inside it:

mkdir -p application/myproject
cd application/myproject
phpcf init

The application code is taken from the folder name, so phpcf init must be run from inside application/{code}/. This launches an interactive wizard that asks for the application's class prefix (and optionally an admin preset), then generates the project scaffolding. You can also pass --prefix=, --domain=, --title= up front to skip the corresponding question.

Configure the Domain

  1. Create a domain configuration file in the data/domain/ directory. If the data/ directory does not exist, create it first:

    mkdir -p data/domain

  2. Create a file named after your development domain, for example myproject.dev.cresenity.com.php:

    <?php
return [
    'app_code' => 'myproject',
    'app_id'   => '1',
    'org_code' => 'myproject',
    'org_id'   => 1,
];

  3. Point your local web server (or /etc/hosts) to the domain and open it in your browser:

    http://myproject.dev.cresenity.com

Next Steps