Installation
Setup
Note: You could use the ready-to-use (pre-compiled) demos available
in the dist folder, if you are not looking for any
customization. In that case, you can skip below setup steps.
We are using Vite which allows to have complete automatation for build flow. In case if you don't know - Vite 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. Please follow below steps to install and setup all prerequisites:
Prerequisites
Please follow below steps to install and setup all prerequisites:
-
Node.js
In order to use build tools you will need to download and install Node.js. If you do not have Node.js 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 -
Vite & Vite CLI
Make sure to have the Vite installed & running in your computer.
-
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.
-
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
Installation
You can run the following commands to run project locally or build for production use:
You can run this app following package manager: Bun, Yarn or NPM
1. Bun (Recommended)
If you don't have bun installed on your PC, use the npm i -g bun or sudo npm i -g bun to install
| Command | Description |
|---|---|
bun i |
This would install all required dependencies
in node_modules folder.
|
bun dev
|
Runs the project locally, starts the development server. |
bun run build
|
It bundles with production mode. Your app is now ready to be deployed. |
2. Yarn
If you don't have yarn installed on your PC, use the next command npm i -g yarn or sudo npm i -g yarn
| Command | Description |
|---|---|
yarn |
This would install all required dependencies
in node_modules folder.
|
yarn dev
|
Runs the project locally, starts the development server. |
yarn build
|
It bundles with production mode. Your app is now ready to be deployed. |
3. NPM
npm comes preinstalled when you install nodejs
| Command | Description |
|---|---|
npm install |
This would install all required dependencies
in node_modules folder.
|
npm run dev
|
Runs the project locally, starts the development server. |
npm run build
|
It bundles with production mode. Your app is now ready to be deployed. |
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