Continuous Deployment for node.js apps from GitHub to Modulus

Deployment Academy

How to set up Continuous Integration and Continuous Deployment for a Node.js Application from GitHub to Modulus

In this blog post we’re going to deploy a Node.js application from a GitHub repository to Modulus using Codeship.

We’ve set up a simple Node.js application called codefish which contains some Jasmine specs. We’ll use screenshots of this application in this blog post. If you haven’t got your own project to set up but you want to follow along on your computer, just fork the repository.

Continuous Deployment for Node.js projects to Modulus

codefish-node on GitHub

Together, we’re going to deploy this application to Modulus using Codeship.

Codeship Landing Page

First, sign in to Codeship with GitHub. Codeship needs access to your GitHub repositories to be able to set them up. Let’s allow access.

GitHub Access

We’re back at Codeship. Now let’s create your first project.

Let's set up our first project on Codeship

The first step of your project setup is to select GitHub as your repository provider.

Select your repository provider

In the list of your GitHub repositories

Search for your repository in the list

search for the repository you want to set up and select it. In my case I search for “codefish”.

Find your repository in the filtered list

Now your repository is connected and you can set up your test commands:

Set up your test commands

Codefish is a Node.js application. Therefore let’s choose “Node.js” as your technology. This prepopulates the setup commands and the test commands for you.

Select Node.js as your technology

Codeship suggests Node.js 0.10.25, but you can use whatever Node version you like. To find out the Node version of your project, type node -v in the Terminal.

Type ruby -v and find out your Ruby version

Just copy your Node version into the nvm install and nvm use statements.

If you want to run Jasmine specs, please install jasmine-node globally additionally to your node modules. In this case just add npm install -g jasmine-node after npm install.

You don’t need npm test for your Jasmine specs, so you can comment it out by adding a hash key before the command. Instead, add jasmine-node spec to the test commands to run your Jasmine specs.

Comment the test command <code>npm test</code> and add <code>jasmine-node spec</code>” /></a></p>
<p>Now let’s finish your setup and go to the dashboard.</p>
<p><a href=Finish your setup. You are on the Dashboard now

You can trigger a build for your application by pushing to your repository. Let’s add the the Codeship status image to the README file. I use markdown syntax to insert the image.

Copy the code for the Codeship status badge to your README file

Now commit and push this change.

Commit and push your change

This triggered a new build on Codeship.

A new build got triggered on Codeship

You can access the build details by clicking the arrow on the right. Here you can follow the running build.

Click on the arrow to the right to access the build details

A few seconds later your build succeeded! Great!

Look at all the commands that are running

You see all the commands that were run. After a few initial preparation commands Codeship ran the commands that you specified a few moments ago.

You can inspect the output of a single command by clicking on it. For the codefish application, we can see that two Jasmine specs were run.

Look at the log of a single command by clicking on it

You’ve already pushed to your repository, watched your build log and got a green build. So you can finish the assistant at the top.

Finish the setup wizard by clicking on the click to finish button

Now let’s deploy your application to Modulus. Go to your project settings by clicking on the settings icon in the projects dropdown.

Go to your project settings by clicking on the settings icon in the projects dropdown

You are on the Testing Setup screen now

Then navigate to the “Deployment” section.

You are on the Deployment Setup screen now

As we want to deploy to Modulus we click on the “Modulus” button.

Click on the Modulus button

Next you need to fill in your Modulus API token and project name. To generate an API token install the Modulus command line tool first.

Install modulus CLI

Sign in to Modulus with your Github credentials or the credentials you’ve used to sign up on Modulus.

Sign in to modulus CLI

Now you can generate an API token

Create modulus API token

and insert it into your deployment configuration.

Insert modulus API token

In the last config step add the name of your Modulus application. If that application doesn’t exist already it will be created.

Copy and paste the Modulus API key to Codeship

Now save your deployment by clicking on the green checkmark on the right.

Save your deployment configuration by clicking on the green checkmark

From now on Codeship will deploy your application to Modulus everytime you push to your GitHub repository.

You still need to tell Modulus how to run your application.

In your package.json add "main": "start.js", because this file will start your application’s server.

Add Modulus config

Now commit and push this change

Commit and push Modulus config

And immediately another build will start running on Codeship. Let’s go back to your project overview.

Go back to the project overview to see a new running build

After the commands we already know from your first build, your application also gets deployed to Modulus now.

After some initial commands were run your application gets deployed

And about 2 minutes later your application is online.

After about 2 minutes your application is online

In the deployment log you can look up your application’s URL.

Look up application URL

When you open the URL of your Modulus app now, your deployed application appears. You can find mine on codefish-11988.onmodulus.net.

Have a look at the app you just deployed

If you need help with setting up your own application, please use the support link in the top-right corner or please tweet us @codeship!

If you need help please click the support link in the top-right corner or tweet us @codeship

Subscribe via Email

Be sure to join 13,643 subscribers of our newsletter to receive updates on software development best practices, Continuous Delivery and tips and tricks to start shipping your product faster.

Join the Discussion

Leave us some comments on what you think about this topic or if you like to add something.