Skip to content
Examples for the Convergence Real-time Collaboration Engine
JavaScript HTML CSS Ruby Other
Branch: master
Clone or download

README.md

Convergence Logo

Convergence Examples

Build Status

This repository contains several examples that demonstrate using various features of Convergence.

Dependencies

  • ruby, gem
  • jeykll >= 3.6.x
  • Convergence = 1.0.0-rc.4

Development Setup

  1. Ensure development dependencies are installed for your platform.
  2. npm install
  3. bundle install
  4. Copy the src/config.example.js to src/config.js.
  5. Update src/config.js as appropriate for your domain. The default assumes that a convergence server is running on localhost:8000.
  6. npm start
  7. Open http://localhost:4000

Alternatively, you can use Docker to build and run a container as shown below.

Building and Running the Container

To build the examples and associated docker container:

npm run build
./scripts/docker-build.sh

The container can then be run using:

./scripts/docker-run.sh

If you need to modify how the container is run, simply copy the commands in the docker-run.sh file and modify as required.

Convergence Server

An easy way to get the convergence server up and running for the examples is launch the Convergence Omnibus Contianer:

docker run --name convergence -p "8000:80" convergencelabs/convergence-omnibus

Branches

The master branch contains examples that work with the latest released version of Convergence. The develop branch contains new / updated examples that work with the current version of Convergence that is in development and may or may not worth with the latest release version. If you are not developing Convergence you should probably stick with master.

You can’t perform that action at this time.