https://github.com/lipp/lua-jet

Realtime Message Bus for the Web. Lua Implementation
https://github.com/lipp/lua-jet

Last synced: 12 months ago
JSON representation

Realtime Message Bus for the Web. Lua Implementation

• Host: GitHub
• URL: https://github.com/lipp/lua-jet
• Owner: lipp
• License: mit
• Created: 2012-02-29T15:11:31.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2015-06-02T11:07:01.000Z (about 11 years ago)
• Last Synced: 2025-04-19T16:29:27.033Z (over 1 year ago)
• Language: Lua
• Homepage: http://jetbus.io
• Size: 2.31 MB
• Stars: 33
• Watchers: 5
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# About

lua-jet is a [Jet](http://jetbus.io) daemon and peer implementation written in Lua.

[![Build Status](https://travis-ci.org/lipp/lua-jet.png?branch=master)](https://travis-ci.org/lipp/lua-jet/builds)

[![Coverage Status](https://img.shields.io/coveralls/lipp/lua-jet.svg)](https://coveralls.io/r/lipp/lua-jet?branch=master)

# Installation

With luarocks:

    $ sudo luarocks install lua-jet

Most recent github version:

    $ git clone https://github.com/lipp/jet.git

    $ cd jet

    $ sudo luarocks make rockspecs/lua-jet-scm-1.rockspec

# Dependencies

In particular you need libev installed.

Ubuntu / Debian based Linux:

    $ sudo apt-get install libev-dev

OSX with Homebrew:

    $ brew install libev

# Running the daemon

    $ jetd.lua

# Starting an example peer

    $ cd lua-jet

    $ lua example/some_service.lua

# Radar

[Radar](http://github.com/lipp/radar) is a web application that gives you access to a Jet bus.

    $ sudo luarocks install orbit

    $ git clone https://github.com/lipp/radar

    $ cd radar

    $ ./simple_webserver.lua

Watch Your Jet Bus on [Your local Radar](http://localhost:8080).

# Doc

For general information, visit the [Jet Homepage](http://jetbus.io). Look at the [API.md](https://github.com/lipp/lua-jet/blob/master/API.md), the [examples](https://github.com/lipp/lua-jet/tree/master/examples) or the [busted](https://github.com/olivine-labs/busted) test [spec files](https://github.com/lipp/lua-jet/tree/master/spec).

# Tests

To run the tests, busted version 1.11.1  needs to be installed:

    $ sudo luarocks install busted 1.11.1-1

If all is in place, run the tests from within the lua-jet dir like this:

    $ busted spec

For more details on installation and running tests under debian based Linux

see the ".travis.yml" file.