Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 3.75 KB

README.md

File metadata and controls

50 lines (37 loc) · 3.75 KB
Raw

devenv.sh environment for Magento 2 development

If you find my work valuable, please consider sponsoring
Sponsor me on GitHub Buy me a coffee Donate via PayPal

devenv it's a powerful development environment based on NixOS.
It allows you to have containerized environments without containers or hypervisor or emulation, with native performance on any platform.
This is by far the fasted Magento/Openmage development environment I've ever worked with and it's more than worth of the time to learn it.

This repo has a basic (and yet complete) OpenMage project installed via composer and all of the necessary software stack:

  • PHP 8.2 (managed by PHP-FPM and served by Caddy)
  • MySQL 8.0
  • Redis 7.0
  • OpenSearch 2.6
  • Xdebug 3.2
  • MailHog for email testing
  • n98-magerun2

Compatibility

This branch is only compatible with Magento 2.4.6 because of the need for OpenSearch2 support (since ElasticSearch7 is broken in NixOS).

Install the environment

  1. If you don't have devenv/NixOS installed please follow devenv's installation guide, it's actually pretty easy and straightforward.
  2. Then clone this repository to have all the configuration files on your machine

Install Magento 2

  1. Start all services with devenv up
  2. Open another terminal
  3. Enter the development environment shell with devenv shell
  4. Create the magento project in the magento2 folder with composer composer create-project --repository-url=https://mirror.mage-os.org/ magento/project-community-edition:2.4.6 magento2 (I'd prefer MageOS but at the moment 2.4.6 is not available on their repos)
  5. cd magento2
  6. composer install
  7. Install sample data if you want
  8. bin/magento setup:install --base-url='http://magento2.test' --db-host='127.0.0.1' --db-user='magento2' --db-password='magento2' --db-name='magento2' --admin-firstname='admin' --admin-lastname='admin' --admin-email='[email protected]' --admin-user='admin' --admin-password='admin123' --language='en_US' --currency='EUR' --timezone='Europe/Rome' --use-rewrites='1' --backend-frontname='admin' --session-save-redis-host='127.0.0.1' --session-save-redis-port='6379' --session-save-redis-db='0' --cache-backend-redis-server='127.0.0.1' --cache-backend-redis-port='6379' --cache-backend-redis-db='1' --page-cache-redis-server='127.0.0.1' --page-cache-redis-port='6379' --page-cache-redis-db='2' --elasticsearch-host='127.0.0.1' --elasticsearch-port='9200'

Daily use

  1. Enter the project folder
  2. run devenv up to start all the software stack
  3. run devenv shell to enter a shell with all softwares configured properly (like n98-magerun2)

At the moment the project is configured with http://magento2.test as the main domain name (you can change it in the devenv.nix file), so you'll have to add magento2.testto your hosts file first, then you'll be able to open the browser to http://magento2.test.