This README is the one indexed from the repository at its latest ref, not from the tag for this version.

openloft.cr

This is OpenLoft Collaborative Editor 1.0 with call reconnection, using Amber/Crystal 1.0.0. Originally written in Ruby on Rails with ActionCable and ported to Crystal for speed. Featuring: HTML Chat, WebRTC Video/Audio, Collaborative Canvas, Collaborative Text Editor.

Getting Started

These instructions will get a copy of this project running on your machine for development and testing purposes.

Please see deployment for notes on deploying the project in production.

Prerequisites

This project requires Crystal (installation guide).

Development

To start your Amber server:

1. Install dependencies with shards install
2. Build executables with shards build
3. Create and migrate your database with bin/amber db create migrate. Also see creating the database.
4. Start Amber server with bin/amber watch
5. Run redis-server

Now you can visit http://localhost:3000/ from your browser.

Getting an error message you need help decoding? Check the Amber troubleshooting guide, post a tagged message on Stack Overflow, or visit Amber on Gitter.

Using Docker? Please check Amber Docker guides.

Tests

To run the test suite:

crystal spec

Contributing

1. Fork it ( https://github.com/mixflame/openloft.cr/fork )
2. Create your feature branch ( git checkout -b my-new-feature )
3. Commit your changes ( git commit -am 'Add some feature' )
4. Push to the branch ( git push origin my-new-feature )
5. Create a new Pull Request

Contributors

• mixflame Jonathan Silverman - creator, maintainer