Getting Started
Setup Velzon
We are using gulp which allows having complete automation for build flow. In case if you don't know Gulp then it's easy to use it. Gulp is a toolkit for automating painful or time-consuming tasks in the development workflow, so you can stop messing around while building any project. You can read it more about it here.
Prerequisites:
Please follow the below steps to install and setup all prerequisites:
-
Nodejs
Make sure to have 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 18. We suggest you to use LTS version of Node.js.
-
Yarn
Make sure to have the Yarn installed & running on your computer. If you already have installed Yarn on your computer, you can skip this step. We suggest you use Yarn instead of NPM.
-
Gulp
Make sure to have the Gulp installed & running on your computer. If you already have installed gulp on run command
npm install -g gulpfrom your terminal. -
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_v*/HTML/ ) of the project to run the project locally or build for production use:
| Command | Description |
|---|---|
yarn install
|
This would install all the required dependencies in
the node_modules folder.
|
gulp
|
Runs the project locally, starts the development server and watches for any changes in your code, including your HTML, Javascript, sass, etc. The development server is accessible at http://localhost:3000. |
gulp build
|
Generates a /dist directory with all
the production files.
|