Prerequisites

Please follow below steps to install and setup all prerequisites:

• PHP

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

  Download PHP

• Composer

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

  Download Composer

• 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 gulp@4.0.1 from your terminal.

• SQLite3

  Open the download page. SQLite and download command-line tools file for your operating system.

Installation

To setup, follow the below mentioned steps:

You can run this app using one of these package managers Yarn, NPM.

Command	Description
yarn	This would install all required dependencies in node_modules folder.
yarn dev or gulp	This would compile plugin, scss and generates css in public folder.
yarn build or gulp build	It compiles the source assets including scss and bundles into production ready use.
yarn rtl or gulp rtl	This would compile plugin, scss and generates rtl css in public folder.
yarn rtl-build or gulp rtlBuild	It compiles the source assets including scss and bundles into production ready use RTL

Command	Description
npm i OR npm i --force	This would install all required dependencies in node_modules folder.
npm run dev or gulp	This would compile all the resources in public folder.
npm run build or gulp build	It compiles the assets including scss and bundles into production ready use.
npm run rtl or gulp rtl	This would compile plugin, scss and generates rtl css in public folder.
npm run rtl-build or gulp rtlBuild	It compiles the assets including scss and bundles into production ready use RTL

To spin up the Codeigniter development server, follow the below mentioned steps in a separate terminal:

Command	Description
composer i	This will install all required dependencies in vendor folder.
php spark migrate	This will execute all pending migrations to database.
php spark db:seed UserSeeder	This will seed database with data after it's created
php spark serve	Runs the project locally, starts the development server