Skip to content
This repository has been archived by the owner on May 7, 2021. It is now read-only.
ZeissS edited this page Mar 13, 2013 · 19 revisions

This is my Google Wave replacement toy project. It works already quite well; still there are a lot of rough edges. Take a look at the GitHub Issues to get an idea.

Features

The current implementation is a basic subset of Google Wave. After registering you can add friends to your contact list through their email adresses. You can create topics and invite your friends. In a topic you can create posts like in GW.

There currently is no live editing, so only one person at a time can edit a single post. Also the editing itself is not as nice as GW, but it is good enough for us.

API

The API is documented at a separate wikipage.

Installation

Requirements

  1. MySql
  2. PHP5 with a webserver (e.g. Apache)

Steps

  1. Create a new database
  2. Copy the etc/template.config.php to etc/config.php and the database settings
    1. Make sure SIMULATE_LAG constant is set to false for production environments
  3. Run scripte/migrate.php
  4. Copy or link the content of the web/ folder to a http-reachable folder

Tested browser

  1. Chrome
  2. IE 9

For Developers

Technologies

  1. The server site uses pure PHP5 with PDO for access to the MySQL Database
  2. The client uses JQuery to generate the client's html structure.
  3. The communication between the client+server is done using JSON-RPC over HTTP. See the docs/ folder for a description of JSON-RPC.

There is currently no API documentation, since the API is very much a flux.

Versions and Branches

The latest "stable" version can be found in the master branch.

Using git flow each new feature is developed in a separate branch named feature/[featurename]. It will be merged into the development branch when its finished.

The development branch will get merged into master each time its considered "stable".

Code Guidelines / Conventions

  1. Spaces, no Tabs. Two (2) spaces to indent.
  2. Semicolons in Javascript
Clone this wiki locally