Installation and Configuration

The Modus Framework is designed for use with Composer. There are two projects: the Modus framework itself, and the Modus Skeleton, which is a basic project configuration.

Installation Methods

There are three possible ways to use Modus:

Method 1: composer create-project (preferred)

The preferred method of creating a new Modus project is to use the composer create-project command:

composer create-project tailwindsllc/modus-skeleton <project name>

This action will clone the modus-skeleton project to the directory you specified, and then download the composer dependencies for Modus (including Modus itself).

Note: The Modus Skeleton project has not reached stability; to create a project, you'll need to use --stability=dev.

Method 2: Cloning the Modus Skeleton project (intermediate difficulty)

You can also clone the project directly from GitHub:

git clone https://github.com/tailwindsllc/modus-skeleton.git

You're on your own for running Composer:

composer install

Method 3: Cloning the Modus framework (hardest difficulty; not recommended)

You can, if you wish, clone the Modus project directly, or include it as a dependency with your composer installation. However, because you will also need to create the directory structure from scratch (Modus is not tied to a particular directory structure, but the base structure can be helpful for getting going quickly) and the configuration.

You can clone Modus itself:

git clone https://github.com/tailwindsllc/modus.git

Or you can require it as part of your Composer dependencies:

composer require tailwindsllc/modus

Running Modus

You can run Modus for development by using the built-in PHP server. Simply run:

cd /path/to/modus/public
php -S localhost:8000

Modus works well with both Apache and Nginx. Simply direct all requests to the public/index.php file. There's a sample htaccess file in public/htaccess-dist.