Skip to content

yosuke-furukawa/impress.io

Repository files navigation

impress.io = socket.io + impress.js

Build status

What is impress.io?

impress.io is a presentation tool using impress.js and socket.io

Feature

  • Synchronize presenter's page and listeners' page
  • Catch Github webhook, Reload
  • Catch file update, Reload

How to use impress.io

impress.io uses markdown2impress

requirement tools:

  1. Node.js & perl

  2. cpanm

    $ curl -L http://cpanmin.us | perl - --sudo App::cpanminus

  3. grunt

    $ npm install grunt-cli -g

  4. forever

    $ npm install forever -g

How to create presentation

$ git clone git://github.com/yosuke-furukawa/impress.io.git
$ cd impress.io
$ git submodule init
$ git submodule update
$ npm install
$ grunt build // if you have errors, sudo may help you.

Write markdown and use markdown2impress

$ grunt impress:create --file=README.md // or write your markdown
$ open index.html

If you are presenter, you would run socket.io and use it to be better!

How to run socket.io

you need external host for running Socket.io.

$ grunt create:user --user=<username> --pass=<password>
$ grunt server:start
$ grunt server:stop // for stop
  • access http://your_host_name:port/
  • enter your username and password and login.

Recreate impress page for socket.io

$ grunt impress:create --file=README.md --socket_url=http://your_host_name:port/
$ open index.html

If you don't wanna recreate, use watchImpress command

$ grunt impress:watch --file=README.md --socket_url=http://your_host_name:port/

Catch Github webhook, then reload all client browsers.

  • Settings > Service Hooks > WebHookURLs

  • Add http://your_host_name:webhookport/

want to know more?

Use The Source, Luke joda

About

impress.io = socket.io + impress.js

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published