Documentation for HTML version of Rizz

Structure

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


                                    
├── dist (Compiled versions - Ready to publish)
├── src
│   ├── assets - the reusable assets used in different demos
│   │   ├── css
│   │   ├── fonts
│   │   ├── images
│   │   └── js
│   ├── partials
│   └── source html files (all pages of the app)
├── gulpfile.js - containing gulp tasks
├── package.json
├── README.md
└── yarn.lock

Installation

We are using gulp which allows to easily compilation of scss to csss. In case if you don't know - Gulp is a 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

Prerequisites

Please follow below steps to install and setup all prerequisites:

  • 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. We suggest you to use Yarn instead of NPM.

  • Nodejs

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

  • 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.

  • 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

To setup, follow below mentioned steps:

  • Install Prerequisites

    Make sure to have all above prerequisites installed & running in your computer

  • Install Dependencies

    Open your terminal, go to your folder and enter the command yarn install. This would install all required dependencies in node_modules folder.

    After you finished with above steps, you can run the command to compile scss into css: gulp

    gulp build Generates a /dist directory with all the production files.

SCSS & CSS

Rizz comes with power of SCSS. The css files can be generated from scss by simply following below steps:

Following are the stylesheet files:

File Description
bootstrap.min.css Rizz uses the bootstrap v5.3.3 The core bootstrap file is being used in all the pages.
icons.min.css Combines various font icons. You should remove the fonts you don't plan to use from this file and recompile it.
app.min.css The main stylesheet file, it's being generated from scss and contains all the css styles combined.