Quick Start

To get started, you need to do the following:

  1. Prompt uses yarn to manage the dependencies. In order to make it work, you will need NodeJS installed on your system. You can install the node js by downloading the package installer from the official website.
  2. Make sure to have Gulp CLI installed and running at your system level. If you don't, you can install it using following command:
    npm install gulp-cli -g
  3. Unzip your theme bundle zip and open your command line, making sure your command line prompt is at the root of the unzipped theme directory.
  4. Install all the required dependencies using following command:
    yarn install

That's it. Now you are ready to compile everything including sass, js, etc. Please check following instructions for the same:

  1. To watch your Sass, JavaScript, image asset, and HTML changes, run the command below. It will start a local Browsersync instance on port 3000 to serve and auto-refresh your pages as you edit.
  2. When you are ready to go for production use, run the command below. It will create dist folder containing the html files, compiled css, images, etc.
    gulp build
Note: You don't need to setup the above if you are not looking for any style modification. You might want to use the ready-to-use (pre-compiled) version available in the dist folder.