Skip to content
This repository has been archived by the owner on May 7, 2021. It is now read-only.
Velrok edited this page Feb 14, 2012 · 19 revisions

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

Installation

Requirements

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

Steps

  1. Setup a new database and load the script from the database/migrations/ folder to create the necessary tables
  2. Copy or link the content of the web/ folder from the github project to a http-reachable folder
  3. Move template.config.php to config.php (in web/api/) and modify to match the mysql credentials
  4. Set the SIMULATE_LAG constant to false, otherwise you will end up with a bad performance
  5. Open the folder where you have located the files in your favorite browser

For Developers:

If you use Vagrant, you can also use that. You just have to login after starting the VM and create the necessary database manually. This is currently not automated (fixes welcome ;).

Here is a quick tutorial on how to use vagrant with this project.

Tested browser

  1. Chrome
  2. IE 9

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.

Each new feature starts with a f-[featurename] branch and will be merged into the development branch when its finished. The development branch will get merged into master each time its considered "stable".

Clone this wiki locally