Documentation for Node version of Rizz

Structure

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


├── public
│   └── assets
│       └── source
│           ├── css
│           ├── fonts
│           ├── images
│           └── js
├── routes
│   └── route.js
├── views
│   ├── auth
│   └── partials
├── app.js
├── bun.lockb
├── config.env
├── gulpfile.js - containing gulp tasks
├── package-lock.json
├── package.json
└── yarn.lock
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

    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.

Installation

To setup, follow the below mentioned steps:

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.
bun gulp or gulp This would compile all the resources from assets/source folder toassetsfolder.
bun dev Runs the project locally, starts the vite and node development server.
bun run build or gulp build It bundles with production mode. Your app is now ready to be deployed.
bun preview It boots up a local static web server that serves the files.
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.
yarn gulp or gulp This would compile all the resources from assets/source folder toassetsfolder.
yarn dev Runs the project locally, starts the vite and node development server.
yarn build or gulp build It bundles with production mode. Your app is now ready to be deployed.
yarn preview It boots up a local static web server that serves the files.
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.
npm run gulp or gulp This would compile all the resources from assets/source folder toassetsfolder.
npm run dev Runs the project locally, starts the vite and node development server.
npm run build or gulp build It bundles with production mode. Your app is now ready to be deployed.
npm run preview It boots up a local static web server that serves the files.