Bringing up a Frontastic Machine
To work on the backend for frontend of your project, you'll need a Frontastic Machine and you'll also need to set up code synchronization. To do this, follow the steps below.
Once finished you can copy essential details about your Frontastic Machine using the copy icon or use the eye icon to reveal the password:
ssh-copy-idso that the public part of your SSH key ends up on the machine, for example:
Once this runs successfully you should be able to login to the machine over SSH without entering a password. You can then either user Frontastic CLI (see this article) or you can follow the steps below to install Mutagen.
PATH(it could even be the code checkout directory itself)
mutagenand a package
mutagen-agents.tar.gz. You need both files in the same directory and mustn't extract the
mutagen-agents.tar.gzfile but leave it there as is.
Note: This config will change when you shut down and bring up a Frontastic Machine again and also when you create a new Machine. That means you need to download a new config.
You should also download the
/etc/hosts snippet for your Machine from Backstage and add/update your computer's
/etc/hosts file accordingly.
mutagen project start
Mutagen will now do it's magic, which might take a while on first start. Once the command has finished, you'll have the Mutagen daemon running in the background. This watches your code files and files on the Frontastic Machine, and synchronizes between them when necessary.
We only perform two-way synchronization where absolutely necessary. Everything else is synchronized strictly in one direction. That means especially:
src/ is only synchronized upstream and
vendor/ is only synchronized downstream. This is important to know for dependency management.
Working with Mutagen
Once you're done with your work you can shutdown Mutagen using:
mutagen project terminate
If you experience any kind of issues you can use the following command to inspect the state of Mutagen:
mutagen project list
Dependency Management (Composer) and Filesync
Synchronizing code between your local host and the remote Frontastic Machine is a non-trivial task. To make it as simple and therefore resilient as possible we decided to synchronize as much one-way as possible. Therefore, dependencies must be managed on the remote host!
To install or remove a package do the following:
- SSH into the Frontastic Machine (see above)
- cd into your project directory (for example,
- Run the corresponding composer command there (see getcomposer.org)
composer.lock files will then be synchronized downstream to your code checkout so that you can commit any changes.
Running the Frontend
To run the frontend, please use Frontastic CLI as explained in the next article.
‹ Back to Article List