Skip to content

Latest commit

 

History

History
143 lines (119 loc) · 4.95 KB

appendix-c.md

File metadata and controls

143 lines (119 loc) · 4.95 KB

Appendix C: Deploy on the web with Heroku

In this workshop, you developed your web service on the local machine (i.e. http://localhost/) which means that only yourself and people on the same network can eventually access your web site using your ip address.

For example, you can use http://localhost/ or http://127.0.0.1/ to access your machine web site (127.0.0.1 is the default address for your network card), and other people should use the real ip address instead (usually something like http://192.168.1.55/). Running a web site on the local machine is only required for development purpose, but you may want to make the web site available to anyone in the world. To do this you need to deploy your web site on a web server.

A very easy way to do host a website is to use 'heroku'. Heroku provides up to 5 free apps.

Step 1 Create a separate branch, named "deployment".

$ git checkout -b deployment

The instructions now assume that you are working on the "deployment" branch.

Edit the .gitignore file so that credentials.js is included when committing and pushing. Open .gitignore file, scroll down to the bottom, find "credentials.js" and comment it out by putting a hash in front of it:

# API credentials file
# credentials.js

# webstorm project files
.idea

Commit the changes to the "deployment" branch.

git add .
git commit -am 'edit the gitignore to include credentials.js to changeset'

Step 2 Sign up on heroku.com for a free account

Step 3 Download and install the Heroku Toolbelt, you can learn more about the Heroku Command Line Interface if you want to know detailed instruction of the usage.

Step 4 Log in to your Heroku account and follow the prompts to create a new SSH public key.

$ heroku login
Enter your Heroku credentials.
Email: <your heroku account here>
Password (typing will be hidden):
Authentication successful.

Step 5 Create a new Heroku app through command line, it will create an app with a random name if you do not give one in command line. It also add a git remote to Heroku so that you can deploy your code by git push.

$ heroku create
Creating quiet-shore-6917... done, stack is cedar-14
https://quiet-shore-6917.herokuapp.com/ | https://git.heroku.com/quiet-shore-6917.git
Git remote heroku added

Step 6Now your development is ready, you can work on your app following the tutorial Chapter2 or Chapter3, and commit your changes to the repository, please note that your changes are not pushed to remote Github or Heroku yet.

git add .
git commit -am 'a running version'

Step 7 Deploy your website to Heroku using Git. Heroku will detect your app and setup the corresponding hosting environment, and then host it for you.

git push heroku master

Once the deployment process is completed, ensure that at least one instance of the app is running (do this only once):

$ heroku ps:scale web=1

Step 8 Once the deployment is completed, you can open the website on the command line, like this:

heroku open

This will launch your website in your default web browser. heroku open uses HTTPS by default, however, you need to use HTTP instead for now. This limitation is due to some known issue of the 3D viewer. For example, browse to http://quiet-shore-6917.heroku.com instead of https://quiet-shore-6917.heroku.com

Step 9 Now you can keep working on the project on your local machine, making some changes, testing on local machine and commit when the tests have passed until you are ready to deploy.

git add .
git commit -am 'some other changes'

Step 10 Now you are ready to deploy. Deploy your changes to heroku using git push.

git push heroku master

You can repeat step 9 ~ 10 to keep working on your project and redeploy it. Heroku will redeploy your app with the updated version.

Note: Go to heroku.com, on the 'Activity' tab of your app, you can see when and if your site was rebuilt successfully or not.

Important: to let heroku know how to build the web site automatically, you need to provide a proper 'package.json' file where you mention the dependencies and the main server script. An example is provided below:

{
	"name": "AdnViewerBasic",
	"description": "A basic node.js server sample",
	"version": "1.0.0",
	"dependencies": {
		"serve-favicon": ">= 0.0.2",
		"express": ">= 4.12.3",
		"request": ">= 2.55.0"
	},
	"files": [
		"LICENSE",
		"README.md"
	],
	"engines": {
		"node": ">= 0.10.0"
	},
	"contributors": [
		"MyName <[email protected]>"
	],
	"license": "MIT",
	"scripts": {
		"start": "node server.js"
	},
	"repository": {
		"type": "git",
		"url": "https://github.com/Developer-Autodesk/workflow-node.js-view.and.data.api.git"
	}
}

========================= Home