README

The skeleton of Melis Platform.
This is the package you need to use to start a setup of Melis Platform.

Requirements

PHP 7.0+
PHP openssl extension
PHP json extension
PHP pdo_mysql extension
PHP zip extension

Installation Options

Standard Installation with Composer

Download Composer

Install the skeleton with submodules using one of these methods:

# Method 1: Using create-project with --keep-vcs flag to preserve Git information
composer create-project melisplatform/melis-platform-skeleton .

# After create-project, initialize and update submodules
git submodule init
git submodule update

# Method 2: Clone with submodules directly
git clone --recursive https://github.com/melisplatform/melis-platform-skeleton
composer install

Setup your HTTP server (as described in HTTP server config section)
Add this entry to your hosts file if you're working locally: 127.0.0.1 www.mysite.local
Create a database, using utf8_general_ci encoding
Go to the following URL: http://www.mysite.local/ and do the setup
You can now connect at http://www.mysite.local/melis

Docker Installation

To run Melis Platform using Docker:

Clone the repository with submodules:

# Clone with submodules in one command
git clone --recursive https://github.com/melisplatform/melis-platform-skeleton

# Or, if already cloned, initialize and update submodules
git submodule init
git submodule update

Follow the setup instructions in the melis-docker submodule documentation.

HTTP server & vhost configuration

Setup a virtual host that points to the public/ directory of the project.
Add the MELIS_PLATFORM (identifies your platform when having multiple environments like local/preprod/prod) and MELIS_MODULE (identifies which site will be loaded as the front office for this domain) variable.
Vhost should look like this:

<VirtualHost *:80>
    DocumentRoot "PATH_DOCROOT/public"
    <Directory "PATH_DOCROOT/public">
        Options -Indexes +FollowSymLinks +ExecCGI
        DirectoryIndex index.php
        Order allow,deny
        Allow from all
        AllowOverride All
        Require all granted
    </Directory>

    ServerName www.mysite.local:80
    SetEnv MELIS_PLATFORM "development"
    SetEnv MELIS_MODULE "MelisDemoCms"

</VirtualHost>

If you are using Windows, you might want to add the following lines in your vhost to ensure that downloads of modules through composer can be managed by PHP.
Be aware that running composer through PHP (setup, marketplace, updates) requires memory and space.

<VirtualHost *:80>
    [...]
    <IfModule fcgid_module>
        FcgidIOTimeout 3600
        FcgidBusyTimeout 1800
        FcgidConnectTimeout 3600
        FcgidOutputBufferSize 65536
        FcgidMaxRequestsPerProcess 500
        FcgidMinProcessesPerClass 0
        FcgidProcessLifeTime 3600 
    </IfModule>
    [...]
</VirtualHost>

Contributing

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Feel free to fork the project, create a feature branch, and send us a pull request!

Authors

Melis Technology - www.melistechnology.com

See also the list of contributors who participated in this project.

License

This project is licensed under the OSL-3.0 License - see the LICENSE file for details

melisplatform / melis-platform-skeleton

Maintainers

Details