Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2 KB

README.md

File metadata and controls

59 lines (37 loc) · 2 KB

Chat Server

Live demo at heroku

Codeship Status for vjames19/chat-server Coverage Status

Prerequisites

  • Node.js and npm - Download and Install Node.js. You can also follow this gist for a quick and easy way to install Node.js and npm.
  • Gulp - Gulp - Install npm install -g gulp.
  • Bower - Bower - Install npm install -g bower.

How to install

To install execute:

git clone https://github.com/vjames19/chat-server.git
cd chat-server
npm install # Installs all the dependencies and builds the server.

To run execute:

npm start # Starts the server.

To develop execute:

gulp server # This will build the server, watch for changes and rebuild if necessary.

Then open a browser:

http://localhost:3000

Environment Variables

* NODE_ENV - Can be production or development or test. This sets the initial log level.
* PORT - The port the server should listen to.

Test

To execute the tests execute gulp test. This will also, generate a coverage report, which lives under ./coverage

Alternatively, the coverage report can be viewed in coveralls.

Deployment

Continuous Deployment and Integration its taken care by Codeship. If the test pass on codeship, the application then gets deployed to heroku(http://vj-chat-server.heroku.com/).

Code Style

Follow the following general settings:

indent_style = space
indent_size = 2
continuation_indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true