How to install Orpheus Framework ?

Orpheus PHP Framework comes with an easy-to-use installer allowing you to create an Orpheus project with a single line command. You could also manually download the archive from GitHub.

Use the Installer Setup

This feature is using composer to direct download Orpheus with its dependencies.

Download the latest installer version

First, download the latest phar of the installer from GitHub.

Run the setup

In the parent folder of your new project, run the setup php orpheus.phar install my-project-name.
Orpheus & Composer will be installed in a sub-folder named my-project-name.

Manual Download

You could also create a project by yourself, just download directly Orpheus.

The Latest

An archive of original sources, consider that Composer is not initialized.

Download Latest

The Releases

All releases, get the version you want by browsing our repos on GitHub.

Browse Releases

The GitHub

Directly browse the sources, you could clone it from GitHub.

See our GitHub

How to start with Orpheus Framework ?

The Orpheus Framework is entirely customizable, but it starts with MVC Library, an ORM and all features you need to get an enhanced website.

Understanding Orpheus

Orpheus separates different package features in namespaces and composer is helping you to maintain your application up-to-date by taking care of your dependencies.
Web access point is /app/web, and you will find some themes in it, each theme has its own css, js and layout files, basic layout files are in PHP and the default theme is... default.
You should put your own sources in /libs/src, you will find some sample here to help you to start.

Create your very first page

We are calling a route and access point to a controller, who is in charge to process the request and return a result, like a rendered view. So, with Orpheus, you totally control how a user is getting in and what to return to him.

1. Get a new Controller

Start by creating a Controller in your src folder (libs/src), there is a HomeController class to help you.

2. Draw a new template

Add your layout in the layout/app folder of your theme, all used template are relative to the layout folder.

3. Link a new route

To get it online, create a route in the file config/routes.yaml using instructions and examples we provided.

As you could see, it's so easy !