Habitat Sample Node App
This simple Express app is an example of how to package a Node.js application with Habitat. It's intended to accompany the walkthroughs on the Habitat website, but it can also be run locally on its own.
Follow the Demos!
Alternatively, you can follow the instructions below if you simply want to build and run the app locally.
To package and run this application with Habitat, you'll need to:
Install Docker (if you're on Mac or Windows)
Clone this repository:
$ git clone https://github.com/habitat-sh/sample-node-app.git $ cd sample-node-app
Setup for First-time Users
Before you can build the app, you'll need to create an origin and accompanying keys.
The quickest way to do this is by running
hab setup as described in the Habitat docs and following the prompts:
$ hab setup
Note: The origin name you use during setup will need to be specified in the plan.sh file mentioned in the next section.
Building the Package
habitat directory in this repository, open the
plan.sh file. It should look like this:
pkg_origin=your_origin pkg_name=sample-node-app pkg_version="1.1.0" pkg_deps=(core/node) ...
Next, let's change the version number:
... pkg_version="1.1.1" ...
Save and close the file, then enter the Habitat Studio:
$ hab studio enter
And run a build:
Habitat will produce a package (a
.hart file) and place it in the
Running the Package with Docker
Still in the Studio, right after the build, export that package as a Docker image:
[default:/src:0]# source results/last_build.env [default:/src:0]# hab pkg export docker results/$pkg_artifact
Then exit the Studio:
And start a Docker container with your newly created image:
$ docker run -it -p 8000:8000 <YOUR_ORIGIN>/sample-node-app
Now head to http://localhost:8000 and see your running app!