Skip to main content

Installation

The installation process consists of installing the Vortex template into your project's codebase, and then setting up the integrations with the required services and hosting providers.

We automated the first part by providing an interactive installer. The second part is a manual process that requires you to follow the instructions provided for each service.

Installing Vortex into a new project​

  1. Create a new directory for your project and navigate to it.

  2. Run the following command to install the Vortex template.

    Install using interactive prompts
    curl -SsL https://www.vortextemplate.com/install > installer.php && php installer.php

  3. Run the following command to commit the initial project structure.

    Commit the initial project structure
    git add .
    git commit -m "Initial commit"

  4. Create a new repository on GitHub and push the initial commit to it.

  5. Enable integrations with your preferred continuous integration provider.
    See onboarding guides for GitHub Actions or CircleCI.

  6. Enable integrations with your preferred hosting platform.
    See onboarding guides for Acquia or Lagoon.

Installing Vortex into an existing project​

The installer cannot predict the state of your project, so it is recommended to initialize Vortex into a new directory and then merge the changes from your existing project into the new one.

warning

Make sure to back up your project before proceeding with the following steps.

tip

Installing into existing project may update some of the Composer dependencies to newer versions, so it is always a good idea to run the Vortex installation on the codebase with the most recent versions of the dependencies.

  1. Create a temporary directory and copy all the files, including hidden files, from your existing project into it.

  2. Create a new branch in your existing project.

  3. Remove all files except for .git directory in your existing project directory.

  4. Run the following command to install the Vortex template.

    Install using interactive prompts
    curl -SsL https://www.vortextemplate.com/install > installer.php && php installer.php

  5. Commit the changes. At this point, you have a clean Vortex installation relevant to your project.

  6. Copy the files from the temporary directory back into the project directory, overriding the files that were installed by Vortex. Git status will show the changes between the Vortex files and your files.

  7. Selectively choose which changes to keep and which to discard:

    • Potentially, you may want to remove the module and theme examples provided by Vortex.

    • composer.json would need to be merged manually, preserving all the entries from the Vortex's composer.json. These entries are required for the features you select during the installation.

    • composer.lock would need to be removed and fully regenerated by running composer install. This could potentially update some other dependencies to newer versions, so it is always a good idea to run the Vortex installation on the codebase with the most recent versions of the dependencies.

  8. Commit the changes to the new branch and push to remote.

  9. Enable integrations with your preferred continuous integration provider.
    See onboarding guides for GitHub Actions or CircleCI.

  10. Enable integrations with your preferred hosting platform.
    See onboarding guides for Acquia or Lagoon.

Updating Vortex​

Head to Updating Vortex for detailed instructions on how to update your project to the latest version of Vortex.