Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 4.17 KB

README.md

File metadata and controls

114 lines (78 loc) · 4.17 KB
Raw

RTC - Real Time Chat

Crafted with NodeJS, ExpressJS and Socket.io.

Getting started

Download the application, or clone the repository:

$ git clone https://github.com/simonewebdesign/real-time-web-chat.git rtwc

Go into the folder and start the server:

$ cd rtwc
$ npm start

Documentation

See here.

Repo layout

File/Folder Description
node_modules/ Any Node modules packaged with the app
package.json npm package descriptor
.openshift/ Openshift specific files
.openshift/action_hooks/pre_build Script that gets run every git push before the build
.openshift/action_hooks/build Script that gets run every git push as part of the build process (on the CI system if available)
.openshift/action_hooks/deploy Script that gets run every git push after build but before the app is restarted
.openshift/action_hooks/post_deploy Script that gets run every git push after the app is restarted

Notes about layout

Please leave the node_modules and .openshift directories but feel free to create additional directories if needed.

Note: Every time you push, everything in your remote repo dir gets recreated. Please store long term items (like an sqlite database) in the OpenShift data directory, which will persist between pushes of your repo. The OpenShift data directory is accessible relative to the remote repo directory (../data) or via an environment variable OPENSHIFT_DATA_DIR.

Environment Variables

OpenShift provides several environment variables to reference for ease of use. The following list are some common variables but far from exhaustive:

process.env.OPENSHIFT_GEAR_NAME  - Application name
process.env.OPENSHIFT_GEAR_DIR   - Application dir
process.env.OPENSHIFT_DATA_DIR  - For persistent storage (between pushes)
process.env.OPENSHIFT_TMP_DIR   - Temp storage (unmodified files deleted after 10 days)

When embedding a database using 'rhc app cartridge add', you can reference environment variables for username, host and password:

process.env.OPENSHIFT_DB_HOST      - DB Host
process.env.OPENSHIFT_DB_PORT      - DB Port
process.env.OPENSHIFT_DB_USERNAME  - DB Username
process.env.OPENSHIFT_DB_PASSWORD  - DB Password

When embedding a NoSQL database using 'rhc app cartridge add', you can reference environment variables for username, host and password:

process.env.OPENSHIFT_NOSQL_DB_HOST      - NoSQL DB Host
process.env.OPENSHIFT_NOSQL_DB_PORT      - NoSQL DB Port
process.env.OPENSHIFT_NOSQL_DB_USERNAME  - NoSQL DB Username
process.env.OPENSHIFT_NOSQL_DB_PASSWORD  - NoSQL DB Password

To get a full list of environment variables, simply add a line in your .openshift/action_hooks/build script that says "export" and push.

List of globally installed and available npm modules

DB drivers:

  • mongodb
  • mysql
  • pg

Other modules (including frameworks, middleware etc):

  • async
  • connect
  • express
  • formidable
  • generic-pool
  • hashish
  • mime
  • mkdirp
  • node-static
  • qs
  • traverse

Test Suite

First install Jasmine:

$ npm install jasmine-node -g

Then you can run the test suite with:

$ jasmine-node . --autotest --watch spec

Or with RequireJS:

$ jasmine-node --runWithRequireJs --requireJsSetup spec/requirejs-setup.js spec

If you want Jasmine to automatically rerun the whole test suite when a file changes, use:

$ jasmine-node . --verbose --runWithRequireJs --requireJsSetup spec/requirejs-setup.js --autotest --watch spec

--

This application is Open Source software released under the MIT license. Kudos to Nettuts+ and OpenShift.