Skip to content
Code that powers Rizzoma collaboration platform
CoffeeScript JavaScript CSS HTML Other
Branch: master
Clone or download
Latest commit 25dd819 Aug 2, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
data/avatars
etc
node_modules
src
.editorconfig
.gitignore
Cakefile
LICENSE
README.md
app.js
package.json

README.md

Rizzoma Collaboration Platform

Rizzoma is a powerful web-application for realtime collaboration. It was created with Google Wave principles in mind and features tree-structured discussions, gadget-form extensions and multimedia support. Rizzoma is an ultimate solution for team communication which can be used as knowledge-management and discussion platform at the same time. Watch short video or see it online - Rizzoma.com.

Just want to get hacking in a virtual machine?

Don't directly clone this repo, but instead get the Rizzoma Vagrant Skeleton, follow the steps and get hacking! :)

Want to know how to do it properly on your local machine - follow the steps below!

Build and run

Install requirements:

Node.js 0.10, CouchDB, RabbitMQ, SphinxSearch, Redis (optional), ImageMagick (optional)

On Debian/Ubuntu:

sudo apt-get install build-essential libssl-dev couchdb rabbitmq-server sphinxsearch redis-server imagemagick libicu-dev

Install Node Version Manager or similar tool. Install Node.js 0.10.x:

nvm install v0.10
nvm use v0.10
# to check Node.js version run:
node -v

Build:

  • git clone and cd to the project root
  • cp src/server/settings_local.coffee.template src/server/settings_local.coffee
  • node_modules/.bin/cake build-server build-client
  • configure SphinxSearch (optional, TBD)

Run:

Learn internals

Rizzoma architecture described in details in this topic

In short:

  • Operational Transformation (via ShareJS library + our custom types for rich text) for topic state synchronization, concurrent text editing and a bit of offline
  • Hard research work for multi-cursor concurrent realtime multi-language WYSIWYG editor with embedded non-editable elements that works in Chrome, Firefox, IE, Safari, Opera, Android and iOS browsers
  • CoffeeScript, Browserify for client
  • Node.js, CoffeeScript, RabbitMQ, Express, Swig templates for backend
  • SockJS (WebSocket) and REST APIs for client-server
  • CouchDB, Redis, S3 for data storage
  • SphinxSearch for topics/mentions/tasks list and full text search
  • Shindig for embedding OpenSocial gadgets
  • Google and Facebook oAuth and contacts, email notifications and reply by email, Android application, Hangouts, Google Calendar, Google Drive, Chrome extensions

Other topics: REST API, Developing gadgets with OpenSocial, Topic export (structure and converters)

Make changes

Server side entry points:

  • src/server,
  • src/server/app_roles/web_wave.coffee, src/server/templates/wave*.html - web (views and templates),
  • src/server/common/root_router.coffee - API module routing.

For most changes to apply just restart ./app.js.

Client entry points:

  • src/client, src/static

For .coffee files changes to apply run node_modules/.bin/cake build-client, for .css changes - just press F5.

Help Rizzoma

  • Contribute code. Bug fixes, new features, documentation and translations are welcome. Please make one feature or bug fix per pull request. Do not hesitate to ask questions.
  • Spread a word, like, star the repo ;)
  • Sponsor feature development or just upgrade your Rizzoma plan to support the project.

Who is behind Rizzoma and license

Rizzoma Project was created and is developed by the Tekliner team with great help from the community. Rizzoma.com service is provided and supported by Tekliner. Write us a line - support@rizzoma.com

Copyright 2011-2017 Tekliner, http://tekliner.com/
Copyright 2011-2017 Rizzoma Project, https://rizzoma.com/

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this project files except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
You can’t perform that action at this time.