You can develop with Magek using any of the following operating systems:
The latest version of Magek (3.x) requires the current LTS version of Node.js which is 20.x. Magek releases with versions 2.x will only work with the previous Node.js LTS version (18.x).
Info: For more information on upgrades between Magek v2.x.x and v3.x.x, read this page.
For more information on upgrades between Magek v1.x.x and v2.x.x, read this page.
Download the installer from Node.js website, or install it using your system's package manager.
Using Chocolatey package manager, run the following command in your PowerShell
choco install nodejs
Using Homebrew package manager, run the following command on the terminal
brew install node
Just run the following commands on the terminal:
curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt install nodejs
Verify that it was installed properly by checking so from your terminal:
node -v
v14.14.0
npm -v
7.0.0
As soon as you have a Node.js version higher than v14.14, and an npm version higher than
7, you are good to go. Just note that npm comes with node, you don't have to install
it apart.
Alternatively, we recommend you to use a version manager for dealing with different Node.js versions:
nvm - Works with macOS, Linux, and Windows Subsystem
for Linuxnvm-windows - Works with native WindowsMagek will initialize a Git repository when you create a new project (unless you use the --skipGit flag), so it is required that you have it already installed in your system.
choco install git
brew install git
sudo apt install git-all
After installing git in your machine, make sure that user.name and user.email are properly configured.
Take a look at the Git configuration page for more info.
To configure them, run in your terminal:
git config --global user.name "Your Name Here"
git config --global user.email "your_email@youremail.com"
To create a new Magek project, you don't need to install anything, if you have node installed in your machine, you can run:
npm create magek@latest my-project
This command will create a new project using the latest version without requiring any global installations.
For project development after creation, Magek includes the CLI as a dependency in your project. There's no need for global installation - the CLI is automatically available via npx after creating your project.
When you create a project using npm create magek@latest, the CLI is added as a dependency and can be used immediately:
cd my-project
npm install
npx magek version
Verify the Magek CLI installation with the npx magek version command. You should get back something like
npx magek version
@magek/cli/0.16.1 darwin-x64 node-v14.14.0
Tip: The CLI is automatically included in every Magek project - no global installation needed! Use
npx magekfor all CLI commands within your project directory.