Note: Hyper for enhanced real-time customization Layout. Values for the CSS variables are set via Sass If are not familiar with NodeJs and Gulp,
you could use the ready-to-use (pre-compiled) version
available in the dist folder. In that case,
you can skip below setup steps.
We are using Gulp, which allows for complete automation of our build flow. In case you don't know, Gulp is a toolkit for automating painful or time-consuming tasks in development workflows, so you can stop messing around and build something. You can read more about it here. Please follow the steps below to install and set up all prerequisites:
Prerequisites
Please follow the steps below to install and configure prerequisites:
-
Node.js - v16x
In order to use build tools, you will need to download and install Node.js. If you do not have Node.js v16x 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 -
Git
Make sure to have git installed and running in your system.
Install Git -
Gulp & Gulp CLI
Make sure to have Gulp installed and running on your computer. If you already have Gulp installed on your computer, you can skip this step. In order to install, just run the command
npm install -g gulp@4.0.1from your terminal. -
Yarn
Make sure to have Yarn installed and running on your computer. If you already have Yarn installed on your computer, you can skip this step.
Installation
Open your terminal, go to your folder, and enter the
command yarn install. This would install all
required dependencies in the
node_modules folder. And now, you are ready
to run the Hyper for the first time.
You can run the following commands to run projects locally: Or build for production use:
| Command | Description |
|---|---|
gulp |
It allows you to select the demo (via the keyboard arrow up/down key) you would like to run, launches the development server, and monitors for changes in your chosen demo code, including HTML, JavaScript, Sass, and so on. The development server is accessible at http://localhost:3000. |
gulp build |
It compiles the source code for selected demo (via keyboard - arrow up-down key) and bundles with production mode, optimises the build for the best performance. The compiled version would be available inside the dist folder. |
Troubleshooting
-
I am getting error "
Error: ENOENT: no such file or directory, scandir '/root/website/node_modules/node-sass/vendor'" while running npm install, what should I do?If you are getting this error, there could be multiple root causes, please try following workarounds:
-
1. Run
npm rebuild node-sassto re-install node-sass -
2. Delete node_modules folder and re run
npm install
-
1. Run