Node Faye

Faye server with Node & Express

Make sure you have Node.js and the Heroku CLI installed.

• Install Yarn: npm install -g yarn
• Install dependencies: yarn
• Run the server locally: npm start

Development Environment Setup

Local Environment

Docker Compose (Recommended)

This application uses Docker Compose, a tool for defining and running multi-container Docker applications which eliminates "works on my machine" problems when collaborating on code with co-workers. Docker Compose is the recommended Development setup for all environments (MacOS, Linux, Windows), as it more closely resembles the Production environment (containerized Linux).

Install tools and dependencies:

• Virtual Box v5.x or later - Docker requires version 5 or better
• Docker Compose

Configure Environment:

This application follows the 12-factor methodology. Instead of hardcoding configuration, as it relates to API keys, services, and database credentials, we rely on environment variables to handle this sensitive information.

Change the example.env file name to .env.

Build containers, install application and set up database:

$ git clone git@github.com:IS3D/node-faye.git
$ cd IS3D
$ docker-compose build
$ docker-compose up

Your app should now be running on localhost:8080.

Deployment

Heroku

• Push changes to Heroku: git push heroku master

• Getting Started with Node.js on Heroku

• Heroku Node.js Support

• Node.js on Heroku

• Best Practices for Node.js Development

• Using WebSockets on Heroku with Node.js