Skip to main content

​
Video tutorials

If you prefer to watch a video, check out the Maizzle Series on Laracasts. They were originally made for Maizzle 4.x, but the same concepts apply in v5 and only some configuration options are different (see our upgrade guide).

​
Requirements

You’ll need Node.js installed first (comes with NPM included). Use this command to check the version: 
node -v
Maizzle requires at least Node v18.20.0

​
Create a project

The fastest way to get started is with the official Starter. Run this command in your terminal to create a new Maizzle project: 
npx create-maizzle
In the interactive setup wizard, specify the directory name to create the project in, i.e. ./my-project, select the Default Starter, and choose Yes to Install dependencies. Installing the dependencies will take a while, but usually under a minute.
1

Navigate to your project

Switch the current directory to my-project:
cd my-project
2

Install dependencies (if needed)

If you didn’t install dependencies in the interactive setup, do so now:
npm install

​
Manual setup

Alternatively, you may create a new project manually. First, you’ll need to download a Starter project - the following command will create a new project using the official Starter in a directory called my-project: 
npx degit maizzle/maizzle my-project
Next, change the current directory to my-project: 
cd my-project
Finally, install the project’s dependencies: 
npm install

​
Development

Maizzle includes different commands for developing locally on your machine and for building production-ready emails.

​
Local

You can start a development server that watches for file changes and automatically updates a preview in the browser. Do so by running the dev npm script in your project’s root folder: 
npm run dev
This will start the local server at http://localhost:3000 Navigate to one of the Templates there, make a change to it in your editor and save it: your changes will be injected and the page will reflect them almost instantly.

​
Production

Build production-ready emails that have inlined CSS and many other optimizations, by running the following command: 
npm run build
This will use settings in your project’s config.production.js to compile email templates that you can use with your ESP or in your application.
These NPM scripts use the Maizzle CLI, check out the CLI Tool docs for more details.

​
Updating

Maizzle is listed as a dependency in your project’s package.json file:
package.json
"dependencies": {
  "@maizzle/framework": "latest",
}
To use a specific version, first change the value to the desired release number:
package.json
"dependencies": {
  "@maizzle/framework": "5.0.6",
}
Then, re-install dependencies by running npm install in your project’s root folder.

​
Clean update

If for some reason you’re not getting the correct version or are running into installation issues, delete your node_modules folder and your package-lock.json file from the root of your project and then run npm install again. This will do a fresh install of all dependencies.

Build docs developers (and LLMs) love

Get started for freeTalk to us