Installation

• Get Emvicy
  • Initialize
  • Run
• Using ddev
• Requirements

Get Emvicy

clone the 2.x repository branch - this way you have the possibility to perform updates that are available for this branch (requires git to be installed). command

git clone --branch 2.x https://github.com/Emvicy/Emvicy.git Emvicy_2.x;

• alternatively get Emvicy 2.x branch head: https://github.com/Emvicy/Emvicy/archive/refs/heads/2.x.zip
• alternatively get the latest stable Emvicy Release of Emvicy from https://github.com/Emvicy/Emvicy/releases/latest (🛈 latest stable Releases may be relate on other branches than 2.x)

Initialize

cd into the root folder of Emvicy and run emvicy

cd Emvicy_2.x/; php emvicy;

• A new Environment config file /.env will be created automatically containing MVC_ENV=develop (see /2.x/configuration#Environment).
• The Auto-Installer begins to install all necessary files. (In case of errors, a text will prompt up showing details about what went wrong). This may take a moment.

Example output

setup checking
• MVC_ENV is: develop
• User/Group from /public/index.php: admin1(1000) / admin1(1000)
• Installing required Main Application libraries via composer in Background with PID 84623. Please wait.
.......Installation completed.

Run

After that, start Emvicy's local development server.

php emvicy serve

Example output

admin1@erazer:/var/www/html$ php emvicy serve
/usr/bin/php -S 127.0.0.1:1969 -t ./public/
--------------------------------------------------------------------------------
[Sun Feb 2 13:24:12 2025] PHP 8.4.3 Development Server (http://127.0.0.1:1969) started

Now you can call your application in your web browser at http://127.0.0.1:1969.

You should see this Frontend

Using ddev

The following command installs a local development Version of Emvicy 2.x using ddev.

git clone --branch 2.x https://github.com/Emvicy/Emvicy.git Emvicy_2.x; cd Emvicy_2.x; \
git clone --branch 2.x https://github.com/emvicy/Emvicy_ddev.git .ddev; ddev start; \
clear; ddev describe; ddev exec "php emvicy;exit;"

• https://emvicy2x.ddev.site

Find out more about ddev and how to install. If you are not yet familiar with this great tool, I highly recommend that you take a look at it. It will make your development much easier.

Requirements

Operating System

• Linux
• binaries available: sed, find, grep, mv, xargs, rm, ps

PHP

• Version: >=8.4

You also need some PHP-Extensions installed and PHP-functions enabled as listed below.

Required PHP Extensions

Core
ctype
curl
date
dom
fileinfo
filter
iconv
json
mbstring
Phar
posix
Reflection
session
SimpleXML
standard
SPL
zip

Required PHP Functions

mb_strlen
iconv