carlosfunk / heroku-buildpack-angular-spa

Buildpack for Heroku with Angular and Nginx

Heroku Buildpack for Angular Applications

This buildpack will work out-of-the-box with Angular applications. It installs node, nginx and generates a production build with Gulp.

Thanks to our own Tony Coconate for his work on a custom buildpack for Ember CLI, which this is heavily entirely based on.

Usage

Creating a new Heroku instance from an Angular application's parent directory:

$ heroku create --buildpack https://github.com/devmynd/heroku-buildpack-angular-spa.git

$ git push heroku master
...
-----> Heroku receiving push
-----> Fetching custom buildpack
...

Configuration

Variables

You can set a few different environment variables to turn on features in this buildpack.

Nginx Workers

Set the number of workers for Nginx (Default: 4):

heroku config:set NGINX_WORKERS=4

API Proxy

Set an API proxy URL:

heroku config:set API_URL=http://api.example.com/

Set your API's prefix path (Default: /api/):

heroku config:set API_PREFIX_PATH=/api/

Note that the trailing slashes are important. For more information about API proxies and avoiding CORS, read this.

Authentication

Have a staging server? Want to protect it with authentication? When BASIC_AUTH_USER and BASIC_AUTH_PASSWORD are set basic authentication will be activated:

heroku config:set BASIC_AUTH_USER=EXAMPLE_USER
heroku config:set BASIC_AUTH_PASSWORD=EXAMPLE_PASSWORD

Be sure to use https when you set this up for added security.

Force HTTPS

For most Ember applications that make any kind of authenticated requests (sending an auth token with a request for example), HTTPS should be used. Enable this feature in nginx by setting FORCE_HTTPS.

heroku config:set FORCE_HTTPS=true

Custom

Need to make a custom nginx configuration change? No problem. In your Angular application, add a config/nginx.conf.erb file. You can copy the existing configuration file in this repo and make your changes to it.

Caching

The Angular buildpack caches your npm and bower dependencies be default. This is similar to the Heroku Buildpack for Node.js. This makes typical deployments much faster.

To purge the cache and reinstall all dependencies, run:

heroku plugins:install https://github.com/heroku/heroku-repo.git
heroku repo:purge_cache -a APPNAME