Setup

We are using gulp which allows to have complete automation for build flow. In case if you don't know - Gulp is a toolkit for automating painful or time-consuming tasks in development workflow, so you can stop messing around and build something. You can read it more about it here. Please follow below steps to install and setup all prerequisites:

Prerequisites

Please follow below steps to install and setup all prerequisites:

  • Node.js

    In order to use build tools you will need to download and install Node.js. If you do not have Node.js installed already, you can get it by downloading the package installer from the official website. Please download the stable version of Node.js (LTS).

    Download Node.js
  • Gulp & Gulp CLI

    Make sure to have the Gulp installed & running in your computer. If you already have installed gulp on your computer, you can skip this step. In order to install, just run command npm install -g [email protected] from your terminal.

  • Yarn

    Make sure to have the Yarn installed & running in your computer. If you already have installed yarn on your computer, you can skip this step.

  • Git

    Make sure to have the Git installed & running in your computer. If you already have installed git on your computer, you can skip this step

Installation

Open your terminal, go to your folder and enter the command yarn install. This would install all required dependencies in node_modules folder. And now, you are ready to run the Codefox for the first time.

You can run the following commands to run project locally or build for production use:

Command Description
gulp Runs the "vertical" demo locally, starts the development server and watches for any changes in your code, including your html, javascript, sass, etc. The development server is accessible at http://localhost:3000/.
gulp build It compiles the source assets including scss and bundles into production ready use.
Troubleshooting
  • I am getting error "Error: ENOENT: no such file or directory, scandir '/root/website/node_modules/node-sass/vendor'" while running npm install, what should I do?

    If you are getting this error, there could be multiple root causes, please try following workarounds:

    • 1. Run npm rebuild node-sass to re-install node-sass
    • 2. Delete node_modules folder and re run npm install
If you are having any question or difficulty during setup, don't hesitate to contact us. We would be glad to assist you.