Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonewebdesign/real-time-web-chat
A chat server and client built with Node, Socket.io, Express and MongoDB. Hosted on OpenShift
https://github.com/simonewebdesign/real-time-web-chat
chat mongodb nodejs openshift socket-io
Last synced: 2 days ago
JSON representation
A chat server and client built with Node, Socket.io, Express and MongoDB. Hosted on OpenShift
- Host: GitHub
- URL: https://github.com/simonewebdesign/real-time-web-chat
- Owner: simonewebdesign
- Created: 2013-07-03T19:51:07.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-10-30T21:49:38.000Z (about 8 years ago)
- Last Synced: 2024-04-15T11:46:03.944Z (9 months ago)
- Topics: chat, mongodb, nodejs, openshift, socket-io
- Language: JavaScript
- Homepage:
- Size: 6.51 MB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RTC - Real Time Chat
Crafted with NodeJS, ExpressJS and Socket.io.
## Getting started
[Download the application](https://github.com/simonewebdesign/real-time-web-chat/archive/master.zip), 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](http://rtwc-simone.rhcloud.com/docs).
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](https://jasmine.github.io/):
$ npm install jasmine-node -g
Then you can run the test suite with:
$ jasmine-node . --autotest --watch spec
Or with [RequireJS](http://requirejs.org/):
$ 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](http://opensource.org/licenses/MIT). Kudos to [Nettuts+](http://net.tutsplus.com/tutorials/javascript-ajax/real-time-chat-with-nodejs-socket-io-and-expressjs/) and [OpenShift](https://www.openshift.com/).