Node Express Hello World

A hello-world web application written in node.js using Express framework.

• Introduction
• Getting Started
  • Prerequisite
  • Build
  • Usage
• Release
• Contributing
• Testing
• License

Introduction

This is a Hello-World program written in node.js. It introduces beginners to the realm of Nodejs with less complexity and basic functionality. It is quite easier to understand the code of the project to get started. This project create a web server using express framework. The express framework hides the complexity and provides robust set of features and tools to develop web applications. This project can be utilized to run a web server quickly. The server creates a GET request endpoint and listen for GET request. The server can be accessed in any browser or using tolls by which a GET can made e.g cURL. This project is based on a GitLab Project Template.

Getting Started

It is quite simple to get started with the Hello-World web server. It is completely written in Node.js. There are multiple ways to start working with it. The simplest way to get your hands dirty with the web server is to download the docker image. To get better understanding, you can download the source codes and build it yourself. The following subsections will give more details.

Prerequisite

Before you start with the web server, there are certain tools which are required to download.

Git

Download and install the latest version of git. It will be used to clone the project repository. Windows and Mac users can find download and installation instructions here. Ubuntu users can install it with following command.

sudo apt install git

cURL

Download and install the latest version of cURL. It will be used to download nvm installation script and install. Windows and Mac users can find download and installation instructions here. Ubuntu users can install it with following command.

sudo apt install curl

nvm

nvm is a version manager for node.js.Download and install the latest version of nvm. It will be used to install the latest version of node and npm. nvm works on any POSIX-compliant shell (sh, dash, ksh, zsh, bash). Windows users don't need this. The command to download and install nvm is following.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

Node

Download and install the latest version of node. It will be utilized to run the web server. Ubuntu users can use nvm to install multiple version of node.js.

nvm install node

Windows users can find more information here.

Docker

Download and install the latest version of Docker. You will need it if you want to build and run docker image. You can find the detailed installation instructions here.

Docker Compose

Download and install the latest version of Docker Compose. It is required define and run multi-container application. You can find the detailed installation instructions here.

Build

• Clone the project repository

  git clone https://github.com/IoTCrawler/express-hello.git

• Go to directory and build

  docker build -t myuser/myrepo:tag .

Usage

Without docker image

• Install packages using npm

  npm install

• run the web server

  npm start

• Access in browser http://localhost:8000

Using local docker image

• Run the local docker image

  docker run -p 8080:6000 -d myuser/myrepo:tag

• Access it in browser

  http://localhost:8000

Using public docker image

• Pull the image

  docker pull brohitdev/express-hello-world:latest

• Run

  docker run -p 8080:6000 -d brohitdev/express-hello-world:latest

• Access in browser

  http://localhost:8000

With docker-compose

• docker-compose.yml

  version: '2'
  services:
  hello-world:
    image: 'brohitdev/express-hello-world:latest'
    ports:
      - '8080:6000'
  

• Run

  docker-compose up -d

• Access in browser

  http://localhost:8000

Release

Binary and source releases are provided on our Releases page.

Contributing

We welcome contributions to the Hello-world project in many forms. We are busy creating the documentation. We will come soon.

Testing

We are busy creating the documentation. We will come soon.

License

The project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file.