Working with Quick Start

Learn how to included npm scripts to automate your time-consuming tasks in your development workflow with Gulp toolkit.

Quick Start

Geeks uses NPM scripts for its build system. Our package.json includes convenient methods for working with the framework, including compiling code, running tests, and more.

To use our build system and run our documentation locally, you ll need a copy of Geeks s source files and Node. Follow these steps and you should be ready to rock:

  • 1. Download and install Node.js
  • 2. Installing Gulp(This is optional if you used gulp go head if you not then used bun or yarn).
  • 3. Installing Bun(This is optional if you used bun go head if you not then used gulp or yarn).
  • 4. Installing Yarn(This is optional if you used yarn go head if you not then used bun or gulp).
  • 5. Working with Xampp Theme
    • a. Installation: For Windows OS
    • b. Installation: For Linux or macOS
      • a. Command with: Bun
      • b. Command with: Yarn
      • c. Command with: NPM

1. Download and install Node.js

( Installtion in System )

Almost all tooling for modern JavaScript projects is based in Node.js. The download page has prebuilt installation packages for all platforms.

Node is bundled with npm, the package manager for JavaScript.

To verify the installation, open a new terminal window and run:

$ node --version
$ npm --version

2. Installing Gulp.js

( Global Installtion in System )

Please note, first Gulp should be installed globally and for that reason -g command is used. 

$ npm install --global gulp-cli

To verify the installation, open a new terminal window and run:

$ gulp --version

3. Installing Bun

( Global Installtion in System )

Please note, Bun should be installed globally and for macOS & Linux. 

$ curl -fsSL https://bun.com/install | bash

Please note, Bun should be installed globally and for windows

$ powershell -c "irm bun.sh/install.ps1|iex"

To verify the installation, open a new terminal window and run:

$ bun --version

4. Installing Yarn

( Global Installtion in System )

Please note, Yarn should be installed globally and for that reason -g command is used. 

$ npm install --global yarn

To verify the installation, open a new terminal window and run:

$ yarn --version

3. Now Working with Xampp Theme

Navigate to the root /Geeks directory and run npm installto install our local dependencies listed in package.json.

a. Installation: For Windows OS

  • 1. Unzip your project and place it inside the xampp/htdocs folder
  • 2. Changes terminal's directory to move inside the src directory
  • 3. You can use any following package manager: Bun, Yarn or NPM
  • 4. Start the Apache server from Xampp panel
  • 5. Visit localhost/project_name/src after running Apache server locally

b. Installation: For Linux or macOS

You can run this app using any following package manager: Bun, Yarn or NPM:

a. Bun

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 the required dependencies in the node_modules folder. 
$ cd src
 Changes terminal's directory to move inside the src directory. 
$ php -S 127.0.0.1:8000
 Starts the PHP server on 127.0.0.1:8000 address 
$ gulp build
 It bundles with production mode. Your app is now ready to be deployed.

b. Yarn

If you don't have yarn installed on your PC, use the npm i -g bun or sudo npm i -g bun to install

Command Description 
$ yarn
 This would install all the required dependencies in the node_modules folder. 
$ cd src
 Changes terminal's directory to move inside the src directory. 
$ php -S 127.0.0.1:8000
 Starts the PHP server on 127.0.0.1:8000 address 
$ gulp build
 It bundles with production mode. Your app is now ready to be deployed.

c. NPM

npm comes preinstalled when you install Nodejs

Command Description 
$ npm i
 This would install all the required dependencies in the node_modules folder. 
$ cd src
 Changes terminal's directory to move inside the src directory. 
$ php -S 127.0.0.1:8000
 Starts the PHP server on 127.0.0.1:8000 address 
$ gulp build
 It bundles with production mode. Your app is now ready to be deployed.
Contents