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
-
Execute the Jumpstart plugin with this command:
npx @magnolia/cli@latest jumpstartThe project will be created in the current working directory. -
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. -
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.
If you’re jumpstarting a project that requires a license, you must supply a username and a password:
... info: Starting download from: https://nexus.magnolia-cms.com/repository/ ... Downloading [====================] 100% 0.0s ✔ Extracted to /Users/johndoe/MagnoliaProjects/Project42/apache-tomcat info: Enter the credentials for "https://nexus.magnolia-cms.com/service/ ... ? Username jdoe ? Password [hidden]You can use either your Magnolia LDAP credentials, or a token name and a token pass code provided by the Nexus interface.
You can customize the templates list by creating your own project templates file. -
All projects from the default project templates contain the Start plugin. Therefore, you can run the webapp with the following command:
npm run mgnl -- startWindows users using PowerShell must enclose the two consecutive hyphens (
--) in quotes:npm run mgnl "--" ...