Getting Started

  1. Docs
  2. Getting Started
Prerequisites:

Please follow the below steps to install and setup all prerequisites:

Suggestion : Yarn is recommended over npm.
  • Git

    Make sure to have Git is globally installed & running on your computer. If you already have installed Git on your computer, you can skip this step.

  • Nodejs

    Ensure that Node.js is installed & and operational on your computer. If you have Node already set up with a version equal to or greater than 18, you can proceed without repeating this step.

  • Node version support policy
    1. Refer to the releases page for specific information about the supported Node.js versions as they may vary by releases.
    2. Node versions that hit the end of life https://github.com/nodejs/Release, will be dropped from support at each node-sass release (major, minor).
    3. We'll discontinue the production of binaries for unsupported releases and halt compatibility testing for potential issues with dependencies. However, we won't prevent installations for those who wish to manage their own support.
    4. Each new Node.js release demands minor internal adjustments and collaboration with CI providers like AppVeyor and GitHub Actions. To streamline communication, we'll create a single issue where interested parties can subscribe, while any extra issues will be closed.
    Below is a quick guide for minimum and maximum support supported versions of node-sass:-
    NodeJS Supported node-sass version Node Module
    Node 18 8.0+ 108
    Node 16 6.0+ 93
    Node 15 5.0+ 88
    Node 14 4.14+ 83
Once you've completed the preceding steps, you can execute the following commands in the terminal or command prompt from the root directory of velzon for javascript and typescript project. This will either run the project locally or build it for production use:
  • This would install all the required dependencies in the node_modules folder.

    • yarn install or yarn

  • Runs the project locally, starts the development server and watches for any changes in your code. The development server is accessible at http://localhost:3000

    • yarn start

  • After executing the provided command in the terminal, you will obtain this output:
  • Generates a /build directory with all the production files.

    • yarn build

    SCSS: We suggest you to do not change any scss files from the src/assets/scss/custom.scss folders because getting new updates will break your SCSS changes if any you have made. We strongly suggest you use custom.scss file and use that instead of overwriting any theme's scss files.