Installing Maizzle


Maizzle needs a few tools installed on your machine:

Node.js and NPM

You'll obviously need Node.js - NPM comes included with it. To check if they're installed, use these commands:

node -v


npm -v


The maizzle new command for scaffolding a new project works by cloning a Git repo. So it needs Git installed.

Check if you have it, by running this command:

git --version


Maizzle consists of:

  • a CLI tool
  • the Framework
  • a Starter project

When developing emails in Maizzle, you run a CLI command inside your Starter project directory root. That simply asks the Framework to build the emails inside your current project, based on config files it finds in there.

With that in mind:

Install the CLI globally

With NPM:

npm install -g @maizzle/cli

With Yarn:

yarn global add @maizzle/cli

Create a project

maizzle new my-project

That will clone the Maizzle Starter into a directory named my-project at your current path, and will automatically run npm install to install its NPM dependencies for you.

Once that's done, change your current directory to the project root:

cd my-project

Congratulations, you can now start using Maizzle!

Start local email development by running the serve command:

maizzle serve

Ready for production?

maizzle build production

Check out the Commands for more info.