Theme Installation

Prerequisites

There are some prerequisites you need to fulfill to configure your machine before you can begin the development process.

Tip

If you’re using macOS, then Homebrew is the easiest way to install the prerequisites. Check out this guide to install Homebrew on your machine.

Node Js

To install Node.js on your system, run the following command in your terminal:
Don’t forget to run your terminal as administartor

Windows

winget install -e --id OpenJS.NodeJS.LTS
node -v # should print "v20.12.2" or other version number

Mac OS

brew install node@20
node -v # should print "v20.12.2" or other version number

Linux

Please refer to the official documentation to install Nodejs on Linux.

If you’re still unable to install Node.js, please refer to the official documentation: https://nodejs.org/en/download for installation instructions on your system.

Customizing This Theme

Installing Dependencies:

To begin customizing this theme, run the following command to install the required packages:

npm install

Starting the Development Server:

Start the development server using the following command:

npm run dev

Starting the Production Server:

To preview the production-ready version of your theme, use the following command:

npm run preview

Preparing for Theme Hosting:

There are two options for preparing your theme files and folders for hosting, depending on whether you want minified assets or not:

• For Non-Minified Assets:

Run the following command to prepare your theme for hosting with non-minified assets like no images to webp conversion, no css and js minification etc.:

npm run download

• For Minified Assets:

Run the following command to prepare your theme for hosting with minified assets like images to webp conversion, css and js minification etc. (recommended for production):

npm run deploy