Documentation for PHP version of Rizz

Structure

When you extract the zip file you received after purchasing, you will find the following files and folders: 


├── src
│   ├── assets
│   │   └── source
│   │       ├── data
│   │       ├── fonts
│   │       ├── images
│   │       ├── js
│   │       └── scss
│   ├── partials
│   └── services
│       └── database.db
├── bun.lockb
├── gulpfile.js - containing gulp tasks
├── package-lock.json
├── package.json
└── yarn.lock
Prerequisites

Please follow below steps to install and setup all prerequisites:

  • PHP~v8.0
  • 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

    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 from your terminal.

  • SQLite3 (For Windows)

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

Installation

To setup, follow the below mentioned steps:

For Windows OS:

Unzip your project and place it inside the xampp/htdocs folder.

You can run this app following package manager: Bun, Yarn or NPM

1. Bun

If you don't have bun installed on your PC, use the npm i -g bun or sudo npm i -g bun to install

Command Description
bun i
 This would install all required dependencies in node_modules folder.
gulp This would compile all the resources from assets/source folder to assets folder.
gulp build It bundles with production mode. Your app is now ready to be deployed.
2. Yarn

If you don't have yarn installed on your PC, use the next command npm i -g yarn or sudo npm i -g yarn

Command Description
yarn
 This would install all required dependencies in node_modules folder.
gulp This would compile all the resources from assets/source folder to assets folder.
gulp build It bundles with production mode. Your app is now ready to be deployed.
3. NPM

npm comes preinstalled when you install Nodejs

Command Description
npm i or npm i --force
 This would install all required dependencies in node_modules folder.
gulp This would compile all the resources from assets/source folder to assets folder.
gulp build It bundles with production mode. Your app is now ready to be deployed.

Start the Apache server from Xampp panel

visit localhost/<project-name>/src/ after running Apache server locally

For Linux or macOS:

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

You can run this app following package manager: Bun, Yarn or NPM

1. Bun

If you don't have bun installed on your PC, use the npm i -g bun or sudo npm i -g bun to install

Command Description
bun i
 This would install all required dependencies in node_modules folder.
gulp This would compile all the resources from assets/source folder to assets folder.
cd src Changes terminal's directory to move inside the src directory
php -S 127.0.0.1:8000 starts the PHP server on 127.0.0.1:8000 address
gulp build It bundles with production mode. Your app is now ready to be deployed.
2. Yarn

If you don't have yarn installed on your PC, use the next command npm i -g yarn or sudo npm i -g yarn

Command Description
yarn
 This would install all required dependencies in node_modules folder.
gulp This would compile all the resources from assets/source folder to assets folder.
cd src Changes terminal's directory to move inside the src directory
php -S 127.0.0.1:8000 starts the PHP server on 127.0.0.1:8000 address
gulp build It bundles with production mode. Your app is now ready to be deployed.
3. NPM

npm comes preinstalled when you install Nodejs

Command Description
npm i or npm i --force
 This would install all required dependencies in node_modules folder.
gulp This would compile all the resources from assets/source folder to assets folder.
cd src Changes terminal's directory to move inside the src directory
php -S 127.0.0.1:8000 starts the PHP server on 127.0.0.1:8000 address
gulp build It bundles with production mode. Your app is now ready to be deployed.