Jumpstarting a project

The Jumpstart plugin allows you to download a project based on a template defined in the projectTemplates.json file.

The following project templates are available:

  • Standard webapps

  • Demo webapps

  • Webapps with headless project examples

Each template contains a ready-to-use Magnolia Tomcat bundle.

Webapp from the default templates only

  1. Execute the Jumpstart plugin with this command:

    npx @magnolia/cli jumpstart
  2. Choose the webapp type you need to create:

    1) standard-webapps (1)
    2) demo-webapps (2)
    3) headless (3)
    1 Creates an empty webapp. This is a good starting point for any new project.
    2 Creates a webapp similar to the Magnolia Travel Demo.
    3 Creates a headless webapp such as the Magnolia Headless Demo.
  3. Let’s suppose you’ve selected demo-webapps. In the next dialog, choose a template.

    1) magnolia-community-demo-webapp
    2) magnolia-dx-core-demo-webapp (1)
    1 Requires a license. You can contact us for a trial license.

    The plugin then downloads all the necessary files for you.

    You can customize the templates list by creating your own project templates file.
  4. All projects from the default project templates contain the Start plugin. Therefore, you can run the webapp with the following command:

    npm run mgnl -- start
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the Magnolia CLI docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules