Whether you’re aiming to contribute to the Mautic project, customize its features for your clients, or simply explore its capabilities, setting up a local development environment is a crucial first step.
Guide
Requirements
- Computer with Fedora
- Internet access
Steps
- Open the Terminal
- Install the necessary dependencies (Docker and DDEV)
sudo dnf -y install dnf-plugins-core && sudo dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo && sudo dnf install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin && sudo systemctl start docker && sudo docker run hello-world && sudo groupadd docker && sudo usermod -aG docker $USER && newgrp docker && docker run hello-world && sudo sh -c 'echo ""' && echo '[ddev] name=ddev baseurl=https://pkg.ddev.com/yum/ gpgcheck=0 enabled=1' | perl -p -e 's/^ +//' | sudo tee /etc/yum.repos.d/ddev.repo >/dev/null && sudo sh -c 'echo ""' && sudo dnf install --refresh -y ddev && mkcert -install
- Open GitHub Desktop and clone the Mautic repository into your home folder
- Open the Mautic folder in your Terminal
- Start DDEV using
ddev config
- Give a name to the installation or press Enter to use “mautic”
- Press Enter again at the next prompt
- When asked for the project type, press Enter
- Start DDEV with
ddev start
- Start DDEV using
- Access the Mautic installation at https://mautic.ddev.site/ or use the IP (faster)
DDEV indicates that the address is already in use, what do I do?
Run the command docker stop $(docker ps -a -q)
to stop all active containers.
An error appears when accessing the link
Run the commands in the terminal, inside the folder:
ddev ssh
composer install && npm install
It stopped working and the app no longer opens, how can I solve it?
Then do a clean install. It will work again (it’s better than racking your brains trying to fix it).
I deleted the folder to clone again, but GitHub says it is being used
Close VS Code before trying to clone again.
Remember to have your VS Code configured to use LF line endings.