Skip to main content

Managing Node.js-based Web Project Using Gulp and Nodemon

In building a website, there are two main components which are frontend and backend components. If we build a website based on Node.js for the backend side, and of course Javascript and CSS for the frontend side, we should handle our codes in the project differently.

We may perform a linter and the Typescript transpiler for our Node.js codes. While on the frontend side, we may additionally minify and bundle the project styles and scripts. The backend program needs to be restarted when there are any changes in the codes and transpiler is performed. The frontend codes need to be re-bundled when there are also any changes.

Nodemon is a tool that is designed to restart a Node program when a change of the program codes is detected. Gulp is a task runner that can be utilized to watch any changes in the program codes and perform specific tasks.

In this post, we will make a transpiler is run and the backend program is restarted when there are any changes. We will also compile our Sass-based styles and minify our Javascript codes when there are any changes in the frontend codes. For that purpose, we require several tools as follows.

  • gulp, nodemon, & typescript: They are the main tools for managing tasks in the project.
  • gulp-sass & node-sass: They are required for compiling Sass files.
  • gulp-nodemon: This interface allows us to call the Nodemon task in a Gulp process.
  • gulp-run: It is used to run an external program, in this case, we use it for calling the tsc command. Even we can utilize gulp-typescript or babel to transpile Typescript codes, we use the gulp-run tool in this sample to show another option how Gulp can be utilized.
  • gulp-uglify: It can be used for minifying Javascript files.

Our project directory structure will be as follows.

src
-- app.ts
publicSrc
-- styles
-- -- style.scss
-- js
-- -- main.js
built
-- app.js
public
-- styles
-- -- style.css
-- js
-- -- main.js

src and publicSrc directories are where our working source codes are stored.

Then, we can create the gulpfile.js file for defining all desired tasks.

const {series, parallel, src, dest, watch} = require('gulp');
const sass = require('gulp-sass')(require('node-sass'));
const nodemon = require('gulp-nodemon');
const run = require('gulp-run');
const uglify = require('gulp-uglify');

function styleTask() {
  return src('./publicSrc/styles/**/*.scss')
    .pipe( sass({outputStyle: 'compressed'}).on('error', sass.logError) )
    .pipe( dest('./public/styles') );
}

function jsTask() {
  return src(['./publicSrc/js/**/*.js'])
    .pipe( uglify() )
    .pipe( dest('./public/js') );
}

function typescriptTask() {
  return run('tsc').exec();
}

exports.backend = series(typescriptTask);
exports.frontend = parallel(styleTask, jsTask);

// task for one-time build
exports.build = parallel(series(typescriptTask), parallel(styleTask, jsTask));

// task for monitoring code changes, performing additional tasks, and re-running the appliation
exports.watch = function(done) {
  watch(['./publicSrc/styles/**/*.scss'], {ignoreInitial:false, delay:1000}, series(styleTask));
  watch(['./publicSrc/js/**/*.js'], {ignoreInitial:false, delay:1000}, series(jsTask));
  nodemon({ 
    script: './built/app.js',
    ext: 'js ts',
    ignore: [
        'node_modules/'
    ],
    watch:['./src'],
    env: { 'NODE_ENV': 'development' }, // for example
    legacyWatch: true, // for enabling program in containerized environment
    tasks: [
      'backend'
    ],
    done: done
  });
}

We need to make sure that the tsconfig.json file has been configured properly before we run our Gulp program.


Comments

Popular posts from this blog

Rangkaian Sensor Infrared dengan Photo Dioda

Keunggulan photodioda dibandingkan LDR adalah photodioda lebih tidak rentan terhadap noise karena hanya menerima sinar infrared, sedangkan LDR menerima seluruh cahaya yang ada termasuk infrared. Rangkaian yang akan kita gunakan adalah seperti gambar di bawah ini. Pada saat intensitas Infrared yang diterima Photodiode besar maka tahanan Photodiode menjadi kecil, sedangkan jika intensitas Infrared yang diterima Photodiode kecil maka tahanan yang dimiliki photodiode besar. Jika  tahanan photodiode kecil  maka tegangan  V- akan kecil . Misal tahanan photodiode mengecil menjadi 10kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 10 / (10+10) x Vcc V- = (1/2) x 5 Volt V- = 2.5 Volt Sedangkan jika  tahanan photodiode besar  maka tegangan  V- akan besar  (mendekati nilai Vcc). Misal tahanan photodiode menjadi 150kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 150 / (150+10) x Vcc V- = (150/160) x 5

Setting Up Next.js Project With ESLint, Typescript, and AirBnB Configuration

If we initiate a Next.js project using the  create-next-app tool, our project will be included with ESLint configuration that we can apply using yarn run lint . By default, the tool installs eslint-config-next and extends next/core-web-vitals in the ESLint configuration. The Next.js configuration has been integrated with linting rules for React and several other libraries and tools. yarn create next-app --typescript For additional configuration such as AirBnB, it is also possible. First, we need to install the peer dependencies of eslint-config-airbnb . We also add support for Typescript using eslint-config-airbnb-typescript . yarn add --dev eslint-config-airbnb eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks yarn add --dev eslint-config-airbnb-typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser After that, we can update the .eslintrc.json file for the new configuration. { "extends": [ "airb

Configuring Swap Memory on Ubuntu Using Ansible

If we maintain a Linux machine with a low memory capacity while we are required to run an application with high memory consumption, enabling swap memory is an option. Ansible can be utilized as a helper tool to automate the creation of swap memory. A swap file can be allocated in the available storage of the machine. The swap file then can be assigned as a swap memory. Firstly, we should prepare the inventory file. The following snippet is an example, you must provide your own configuration. [server] 192.168.1.2 [server:vars] ansible_user=root ansible_ssh_private_key_file=~/.ssh/id_rsa Secondly, we need to prepare the task file that contains not only the tasks but also some variables and connection information. For instance, we set /swapfile  as the name of our swap file. We also set the swap memory size to 2GB and the swappiness level to 60. - hosts: server become: true vars: swap_vars: size: 2G swappiness: 60 For simplicity, we only check the exi

Raspberry Pi Bluetooth Connection

Raspberry Pi 3 provides a built-in Bluetooth module. The latest Raspbian has been bundled with tools for enabling Bluetooth connection. The Bluetooth icon will be shown up on the top right corner of the desktop. It's a tool to discover available Bluetooth devices and connect Pi with Bluetooth devices. It is easy to connect any Bluetooth-enabled electronic device with Pi. But, sometimes Pi will fail to connect, especially for Bluetooth device that has no standardized services. From a terminal, we can use the  bluetoothctl tool to scan and connect with a Bluetooth device. You should make sure that the BlueZ protocol stack has been installed by running $ apt-get install bluez Run bluetoothctl to enter the tool command window Turn the power on by running power on (Optional) You can set AutoEnable=true in /etc/bluetooth/main.conf if you want to make the Bluetooth auto power-on after reboot. Run devices to see which devices have been paired Run scan on if your desired d

Installing Multiple Instances of Linux Distributions in WSL

By support of WSL (Windows Subsystem for Linux), you can install any Linux distros in a Windows machine. Recommended method from WSL documentation is by downloading the distribution from Microsoft Store or find .appx installation file available in Microsoft website. For running multiple instances of same Linux distribution, you can duplicate the data using export-import procedure, as I have mentioned in another post . Another method that might be more beneficial is by utilizing Docker. Currently, Docker has already had variety of images of Linux distributions in its registry. You can also store your own costumized distribution in Docker registry that can be distributed to any machines instantly. After you had WSL 2 and an installed Linux distribution from Microsoft Store, you are ready to have more Linux instances in your Windows. 1. List all installed distributions in your Windows. wsl --list -v 2. Run the distribution you desired from terminal, for example, you have insta

Generate API Documentation Using Swagger Module in NestJS

Swagger provides us a standard to generate API documentation based on the Open API specification. If we use NestJS for building our API providers, we can utilize a tool provided by NestJS in the  @nestjs/swagger  module to generate the documentation automatically in the built time. This module also requires the swagger-ui-express module if we use Express as the NestJS base HTTP handler. Set Swagger configuration First, we need to define Swagger options and instantiate the documentation provider on the main.ts file. import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'; // sample application instance const app = await NestFactory.create(AppModule); // setup Swagger options const options = new DocumentBuilder() .setTitle('Coffee') .setVersion('1.0') .setDescription('Learn NestJS with coffee') .build(); // build the document const document = SwaggerModule.createDocument(app, options); // provide an endpoint