logo small logo dark logo small logo
  • v1.0
user-image Tosha Minner
Helper Icon Image
Unlimited Access

Upgrade to plan to get access to unlimited reports

Buy Now
  1. Jidox
  2. Installation

Installation

We utilize Gulp to automate our build flow, allowing for complete automation of our development workflows. Gulp is a powerful toolkit designed to help developers eliminate time-consuming tasks, allowing them to focus on what really matters: building great products. If you're not familiar with Gulp, you can learn more about it here.

Prerequisites

To get started with Jidox, please follow the steps below to install and set up all the necessary prerequisites:

  • Node.js - v16x or v18x

    To use our build tools and take full advantage of Hyper's customization options, you will need to download and install Node.js. If you do not have Node.js v16.x or v18.x installed already, you can download the package installer from the official website. We recommend that you download the stable version of Node.js (LTS) to ensure the best possible experience.

    Download Node.js
  • Yarn

    Ensure that you have Yarn installed and running on your computer. If you already have Yarn installed, you can skip this step.

  • Gulp & Gulp CLI

    Ensure that you have Gulp installed and running on your computer. If you already have Gulp installed, you can skip this step. If not, you can install it by running the following command from your terminal: npm install -g gulp.

  • Technical Requirements

    Please check the Technical Requirements from the this link. https://symfony.com/doc/current/setup.html#technical-requirements

  • Composer

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

  • Install Symfony CLI

    Please setup Symfony CLI regarding your computer operating system. https://symfony.com/download. If you already have setup on your computer, you can skip this step.

Installation

After you finished with the above steps, you can run the following commands into the terminal/command prompt from the root directory ( Jidox ) of the project to run the project locally:

You can run the following commands to run projects locally: Or build for production use:

Command Description
yarn install This will install all necessary dependencies in the node_modules folder.
gulp It will compiles source files and monitor changes to your demo code, including HTML, JavaScript, and Sass. For production use gulp build
composer install This would install all required dependencies in vendor folder.
symfony server:start It will run the project locally. The development server is accessible at http://127.0.0.1:8000.
symfony server:start --port=8001 It will run the project locally on different port. The development server is accessible at http://127.0.0.1:8001.
If you encounter any issues or have any questions during the setup process, please don't hesitate to reach out to us via email. We are always here to help and would be glad to assist you in any way we can.