Over a million developers have joined DZone.

Build Node.js Web Apps Using the Windows Azure Table Service

· Cloud Zone

Build fast, scale big with MongoDB Atlas, a hosted service for the leading NoSQL database on AWS. Try it now! Brought to you in partnership with MongoDB.

Curator's note: This tutorial originally appeared on WindowsAzure.com.

This tutorial shows you how to use Table service provided by Windows Azure Data Management to store and access data from a node application hosted in a Windows Azure Web Site. This tutorial assumes that you have some prior experience using node and Git.

You will learn:

  • How to use npm (node package manager) to install the node modules

  • How to work with the Windows Azure Table service

  • How to use the Windows Azure command-line tool for Mac and Linux to create a Windows Azure Web Site

By following this tutorial, you will build a simple web-based task-management application that allows creating, retrieving and completing tasks. The tasks are stored in the Table service.

The project files for this tutorial will be stored in a directory named tasklist and the completed application will look similar to the following:

A web page displaying an empty tasklist

Note: This tutorial makes reference to the tasklist folder. The full path to this folder is omitted, as path semantics differ between operating systems. You should create this folder in a location that is easy for you to access on your local file system, such as ~/node/tasklist or c:\node\tasklist

Note: Many of the steps below mention using the command-line. For these steps, use the command-line for your operating system, such as cmd.exe (Windows) or Bash (Unix Shell). On OS X systems you can access the command-line through the Terminal application.


Before following the instructions in this article, you should ensure that you have the following installed:

  • node recent version

  • Git

  • A text editor

  • A web browser


To complete this tutorial, you need a Windows Azure account that has the Windows Azure Web Sites feature enabled. You can create a free trial account and enable preview features in just a couple of minutes. For details, see Create a Windows Azure account and enable preview features.


Create a storage account

Perform the following steps to create a storage account. This account will be used by subsequent instructions in this tutorial.

  1. Open your web browser and go to the Windows Azure Portal. If prompted, login with your Windows Azure subscription information.

  2. At the bottom of the portal, click + NEW and then select Storage Account.


    storage account

  3. Select Quick Create, and then enter the URL and Region/Affinity for this storage account. Since this is a tutorial and does not need to be replicated globally, uncheck Enable Geo-Replication. Finally, click "Create Storage Account".

    quick create

    Make note of the URL you enter, as this will be referenced as the account name by later steps.

  4. Once the storage account has been created, click Manage Keys at the bottom of the page. This will display the primary and secondary access keys for this storage account. Copy and save the primary access key, then click the checkmark.

    access keys

Install modules and generate scaffolding

In this section you will create a new Node application and use npm to add module packages. For the task-list application you will use the Express and Azure modules. The Express module provides a Model View Controller framework for node, while the Azure modules provides connectivity to the Table service.

Install express and generate scaffolding

  1. From the command-line, change directories to the tasklist directory. If the tasklist directory does not exist, create it.

  2. Enter the following command to install express.

npm install express -g

Note: When using the '-g' parameter on some operating systems, you may receive an error of Error: EPERM, chmod '/usr/local/bin/express' and a request to try running the account as an administrator. If this occurs, use the sudo command to run npm at a higher privilege level.

The output of this command should appear similar to the following:

express@2.5.9 /usr/local/lib/node_modules/express
├── mime@1.2.4
├── mkdirp@0.3.0
├── qs@0.4.2
└── connect@1.8.7

Note: The '-g' parameter used when installing the express module installs it globally. This is done so that we can access the express command to generate web site scaffolding without having to type in additional path information.

To create the scaffolding which will be used for this application, use the express command:


The output of this command should appear similar to the following:

create : .
    create : ./package.json
    create : ./app.js
    create : ./public
    create : ./public/javascripts
    create : ./public/images
    create : ./public/stylesheets
    create : ./public/stylesheets/style.css
    create : ./routes
    create : ./routes/index.js
    create : ./views
    create : ./views/layout.jade
    create : ./views/index.jade

    dont forget to install dependencies:
    $ cd . && npm install

After this command completes, you should have several new directories and files in the **tasklist** directory.

Install additional modules

The package.json file is one of the files created by the express command. This file contains a list of additional modules that are required for this application. For this tutorial, we will be using the following additional modules:

  • azure - provides access to Windows Azure features such as the Table service

  • node-uuid - creates unique identifiers

  • async - functions for asynchronous JavaScript

To add a requirement for additional modules used in this tutorial, perform the following steps:

  1. Open the package.json file in a text editor.

  2. Find the line that contains "jade": . Add a new line after it, which should contain the following:

, "azure": ">= 0.5.3"
, "node-uuid": ">= 1.3.3"
, "async": ">= 0.1.18"

After this change, the file contents should appear similar to the following:

"name": "application-name"
  , "version": "0.0.1"
  , "private": true
  , "dependencies": {
      "express": "2.5.8"
    , "jade": ">= 0.0.1"
    , "azure": ">= 0.5.3"
    , "node-uuid": ">= 1.3.3"
    , "async": ">= 0.1.18"
  1. Save the package.json file.

  2. From the command-line, change directories to the tasklist folder and enter the following to install the modules described in the package.json file:

npm install

The output of this command should appear as follows:

async@0.1.18 ./node_modules/async
node-uuid@1.3.3 ./node_modules/node-uuid
jade@0.26.0 ./node_modules/jade
├── commander@0.5.2
└── mkdirp@0.3.0
express@2.5.8 ./node_modules/express
├── qs@0.4.2
├── mime@1.2.4
├── mkdirp@0.3.0
└── connect@1.8.7
azure@0.5.3 ./node_modules/azure
├── dateformat@1.0.2-1.2.3
├── xmlbuilder@0.3.1
├── log@1.3.0
├── node-uuid@1.2.0
├── xml2js@0.1.14
├── mime@1.2.5
├── underscore@1.3.3
├── qs@0.5.0
├── underscore.string@2.2.0rc
└── sax@0.4.0

Using the Table service in a node application

In this section you will extend the basic application created by the express command by adding a task.js file which contains the model for your tasks. You will also modify the existing app.js and create a new tasklist.js file that uses the model.

Create the model

  1. In the tasklist directory, create a new directory named models.

  2. In the models directory, create a new file named task.js. This file will contain the model for the tasks created by your application.

  3. At the beginning of the task.js file, add the following code to reference required libraries:

var azure = require('azure')
  , uuid = require('node-uuid');

Next, you will add code to define and export the Task object. This object is responsible for connecting to the table.

module.exports = Task;

function Task(storageClient, tableName, partitionKey) {
  this.storageClient = storageClient;
  this.tableName = tableName;
  this.partitionKey = partitionKey;

    function tableCreated(err) {
      if(err) {
        throw error;

Next, add the following code to define additional methods on the Task object, which allow interactions with data stored in the table:

Task.prototype = {
  find: function(query, callback) {
    self = this;
      function entitiesQueried(err, entities){
        if(err) {
        } else {
          callback(null, entities);

  addItem: function(item, callback) {
    self = this;
    item.RowKey = uuid();
    item.PartitionKey = self.partitionKey;
    item.completed = false;
    self.storageClient.insertEntity(self.tableName, item, 
      function entityInserted(error) {

  updateItem: function(item, callback) {
    self = this;
    self.storageClient.queryEntity(self.tableName, self.partitionKey, item,
      function entityQueried(err, entity) {
       if(err) {
        entity.completed = true;
        self.storageClient.updateEntity(self.tableName, entity,
          function entityUpdated(err) {
            if(err) {
  1. Save and close the task.js file.

Create the controller

  1. In the tasklist/routes directory, create a new file named tasklist.js and open it in a text editor.

  2. Add the folowing code to tasklist.js. This loads the azure and async modules, which are used by tasklist.js. This also defines the TaskList function, which is passed an instance of the Task object we defined earlier:

var azure = require('azure')
  , async = require('async');

module.exports = TaskList;

function TaskList(task) {
  this.task = task;

Continue adding to the tasklist.js file by adding the methods used to showTasks, addTask, and completeTasks:

TaskList.prototype = {
  showTasks: function(req, res) {
    self = this;
    var query = azure.TableQuery
      .where('completed eq ?', 'false');
    self.task.find(query, function itemsFound(err, items) {
      res.render('index',{title: 'My ToDo List ', tasks: items});

  addTask: function(req,res) {
    var self = this      
    var item = req.body.item;
    self.task.addItem(item, function itemAdded(err) {
      if(err) {
        throw err;

  completeTask: function(req,res) {
    var self = this;
    var completedTasks = Object.keys(req.body);
    async.forEach(completedTasks, function taskIterator(completedTask, callback){
      self.task.updateItem(completedTask, function itemsUpdated(err){
        } else {
    }, function(err){
      if(err) {
        throw err;
      } else {
  1. Save the tasklist.js file.

Modify app.js

  1. In the tasklist directory, open the app.js file in a text editor. This file was created earlier by running the express command.

  2. At the beginning of the file, add the following to load the azure module, set the table name, partitionKey, and set the storage credentials used by this example:

var azure = require('azure');
var tableName = 'tasks'
  , partitionKey = 'partition'
  , accountName = 'accountName'
  , accountKey = 'accountKey';

Note: You must replace the values 'accountName' and 'accountKey' with the values obtained earlier when creating your Windows Azure storage account.

Replace the content after the //Routes comment with the following code. This will initialize an instance of Task with a connection to your storage account. This is then password to the TaskList, which will use it to communicate with the Table service:

var TaskList = require('./routes/tasklist');
var Task = require('./models/tasks.js');
var task = new Task(
    azure.createTableService(accountName, accountKey)
    , tableName
    , partitionKey);
var taskList = new TaskList(task);

app.get('/', taskList.showTasks.bind(taskList));
    app.post('/addtask', taskList.addTask.bind(taskList));
    app.post('/completetask', taskList.completeTask.bind(taskList));

app.listen(process.env.port || 1337);
  1. Save the app.js file.

Modify the index view

  1. Change directories to the views directory and open the index.jade file in a text editor.

  2. Replace the contents of the index.jade file with the code below. This defines the view for displaying existing tasks, as well as a form for adding new tasks and marking existing ones as completed.

h1= title
  font(color="grey") (powered by Node.js and Windows Azure Table Service)
form(action="/completetask", method="post")
      td Name
      td Category
      td Date
      td Complete
    each task in tasks
        td #{task.name}
        td #{task.category}
        - var day   = task.Timestamp.getDate();
        - var month = task.Timestamp.getMonth() + 1;
        - var year  = task.Timestamp.getFullYear();
        td #{month + "/" + day + "/" + year}
         input(type="checkbox", name="#{task.RowKey}", value="#{!task.itemCompleted}", checked=task.itemCompleted)
  input(type="submit", value="Update tasks")
form(action="/addtask", method="post")
      td Item Name: 
        input(name="item[name]", type="textbox")
      td Item Category: 
        input(name="item[category]", type="textbox")
  input(type="submit", value="Add item")
  1. Save and close index.jade file.

Run your application locally

To test the application on your local machine, perform the following steps:

  1. From the command-line, change directories to the tasklist directory.

  2. Use the following command to launch the application locally:

node app.js
  1. Open a web browser and navigate to This should display a web page similar to the following:

    A webpage displaying an empty tasklist

  2. Use the provided fields for Item Name and Item Category to enter information, and then click Add item.

  3. The page should update to display the item in the ToDo List table.

    An image of the new item in the list of tasks

  4. To complete a task, simply check the checkbox in the Complete column, and then click Update tasks.

  5. To stop the node process, go to the command-line and press the CTRL and C keys.

Deploy your application to Windows Azure

The steps in this section use the Windows Azure command-line tools to create a new Windows Azure Web Site, and then use Git to deploy your application. To perform these steps you must have a Windows Azure subscription. If you do not already have a subscription, you can sign up for one for free.

Note: These steps can also be performed by using the Windows Azure portal. For steps on using the Windows Azure portal to deploy a Node.js application, see Create and deploy a Node.js application to a Windows Azure Web Site.

Note: If this is the first Windows Azure Web Site you have created, you must use the Windows Azure portal to deploy this application.

Install the Windows Azure command-line tool for Mac and Linux

To install the command-line tools, use the following command:

npm install azure -g

Note: If you have already installed the Windows Azure SDK for Node.js from the Windows Azure Developer Center, then the command-line tools should already be installed. For more information, see Windows Azure command-line tool for Mac and Linux.

Note: While the command-line tools were created primarily for Mac and Linux users, they are based on Node.js and should work on any system capable of running Node.

Import publishing settings

Before using the command-line tools with Windows Azure, you must first download a file containing information about your subscription. Perform the following steps to download and import this file.

  1. From the command-line, change directories to the tasklist directory.

  2. Enter the following command to launch the browser and navigate to the download page. If prompted, login with the account associated with your subscription.

azure account download

The file download should begin automatically; if it does not, you can click the link at the beginning of the page to manually download the file.

After the file download has completed, use the following command to import the settings:

azure account import <path-to-file>
  1. Specify the path and file name of the publishing settings file you downloaded in the previous step. Once the command completes, you should see output similar to the following:

    ![The output of the import command][import-publishing-settings]

  2. Once the import has completed, you should delete the publish settings file as it is no longer needed and contains sensitive information regarding your Windows Azure subscription.

Create a Windows Azure Web Site

  1. From the command-line, change directories to the tasklist directory.

  2. Use the following command to create a new Windows Azure Web Site

azure site create --git

You will be prompted for the web site name and the datacenter that it will be located in. Provide a unique name and select the datacenter geographically close to your location.

The --git parameter will create a Git repository on Windows Azure for this web site. It will also initialize a Git repository in the current directory if none exists. It will also create a Git remote named 'azure', which will be used to publish the application to Windows Azure. Finally, it will create a web.config file, which contains settings used by Windows Azure to host node applications.

Note: If this command is ran from a directory that already contains a Git repository, it will not re-initialize the directory.

Note: If the --git parameter is omitted, yet the directory contains a Git repository, the 'azure' remote will still be created.

Once this command has completed, you will see output similar to the following. Note that the line beginning with Website created at contains the URL for the web site.

info:   Executing command site create
help:   Need a site name
Name: TableTasklist
info:   Using location southcentraluswebspace
info:   Executing `git init`
info:   Creating default .gitignore file
info:   Creating a new web site
info:   Created website at  tabletasklist.azurewebsites.net
info:   Initializing repository
info:   Repository initialized
info:   Executing `git remote add azure https://username@tabletasklist.azurewebsites.net/TableTasklist.git`
info:   site create command OK

Note: If this is the first Windows Azure Web Site for your subscription, you will be instructed to use the portal to create the web site. For more information, see Create and deploy a Node.js application to a Windows Azure Web Site.

Publish the application

  1. In the Terminal window, change directories to the tasklist directory if you are not already there.

  2. Use the following commands to add, and then commit files to the local Git repository:

git add .
git commit -m "adding files"

When pushing the latest Git repository changes to the Windows Azure Web Site, you must specify that the target branch is master as this is used for the web site content.

git push azure master

At the end of the deployment, you should see a statement similar to the following:

To https://username@tabletasklist.azurewebsites.net/TableTasklist.git
 * [new branch]      master -> master
  1. Once the push operation has completed, browse to the web site URL returned previously by the azure create site command to view your application.

Next steps

While the steps in this article describe using the Table Service to store information, you can also use MongoDB. See Node.js Web Application with MongoDB for more information.

Additional resources

Windows Azure command-line tool for Mac and Linux



Now it's easier than ever to get started with MongoDB, the database that allows startups and enterprises alike to rapidly build planet-scale apps. Introducing MongoDB Atlas, the official hosted service for the database on AWS. Try it now! Brought to you in partnership with MongoDB.


Published at DZone with permission of Eric Gregory. See the original article here.

Opinions expressed by DZone contributors are their own.

The best of DZone straight to your inbox.

Please provide a valid email address.

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}