Getting Started

  1. Docs
  2. Getting Started

Velzon is a fully featured premium admin dashboard template in Svelte with Sveltekit and with ViteJs and developer-friendly codes.

Prerequisites:

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

  • Nodejs

    Make sure to have the Node.js installed & running on your computer. If you already have installed Node on your computer, you can skip this step if your existing node version is greater than equal to 18.

  • Node version support policy
    1. Supported Node.js versions vary by release, please consult the releases page.
    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 will stop building binaries for unsupported releases, and testing for breakages in dependency compatibility, but we will not block installations for those that want to support themselves.
    4. New node releases require minor internal changes along with support from CI providers (AppVeyor, GitHub Actions). We will open a single issue for interested parties to subscribe to, and close additional issues.
    Below is a quick guide for minimum and maximum support supported versions of node-sass:-
    NodeJS Supported node-sass version Node Module
    Node 20 9.0+ 115
    Node 19 8.0+ 111
    Node 18 8.0+ 108
    Node 16 6.0+ 93
    Node 15 5.0+ 88
    Node 14 4.14+ 83
    Node 13 4.13+, <5.0 79
    Node 12 4.12+ 72
    Node 11 4.10+, <5.0 67
    Node 10 4.9+, <6.0 64
    Node 8 4.5.3+, <5.0 57
    Node <8 <5.0 <57
  • Git

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

After you finished with the above steps, you can run the following commands into the terminal/command prompt from the root directory ( Velzon/admin ) of the project to run the project locally or build it for production use:

Command Description
npm install This would install all the required dependencies in the node_modules folder.
npm run dev Runs the project locally, starts the development server and watches for any changes in your code. The development server is accessible at http://localhost:5173.
npm build Generates a /build directory with all the production files.
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.