SURF

SURF is a threaded instant messaging application, like Google Wave used to be.

website at http://zkiiito.github.io/SURF.

Features / usage

• create new conversation
• add friends from the Edit menu
• if they share a conversation with you, the autosuggested Participants field can find them
• if not, get and invite code and send them! (different code for everyone)
• add a message
• using the textfield at the bottom of the conversation
• reply to another message
  • using the → button, or
  • by double clicking the message
• mention your friend by typing @friendName and pressing Tab button
• jump to the next unread message
• by pressing spacebar
• clicking the Next unread button
• clicking on the current conversation on the left side
• start a private conversation with a friend by double-clicking their avatar

Installation

Requirements

• node.js
• mongodb
• redis

Steps for you local (development) copy

$ git clone git@github.com:zkiiito/SURF.git surf
$ cd surf
$ export TESTMODE=1
$ npm ci
$ node Surf.js

After this, your server is running on http://localhost:8000/ with google authtentication, http://localhost:8000/loginTest with no authentication, and http://localhost:8000/admin for administration (default login with admin/adminPass).

If you need facebook auth, edit the config file /code/Config.js with your facebook appId and appSecret, and http://localhost:8000/auth/facebook will be your friend.

Development

You want to develop? Cool!

Minify client-side js every time it changes:

• setup your IDE to run "npm run build" every time files change in the client/js or admin/js folder, excluding surf.min.js and admin.min.js
• the pre-commit package will take care of uglifying when committing

Test

start the server and

$ npm test

should do the rest!

Creators

Csaba Schreiner design, sitebuild

• https://www.behance.net/csaba-schreiner

Zoltan Feher code

• http://github.com/zkiiito

License

All code released under the GNU GPL v3.0.