You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
asciinema.org/README.md

1.7 KiB

ascii.io Build Status

ASCII.IO is the simplest way to record your terminal and share the recordings with your fellow geeks. Simply record and upload your terminal session with single command, and ASCII.IO will play it back in your browser.

This is the source code of ascii.io website and JS player. If you look for ascii.io terminal recorder go here: sickill/ascii.io-cli

Setup instructions

Below you'll find setup instructions in case you want to contribute, play with it on your local machine or setup your own instance for your organization.

Requirements

ascii.io site is a Ruby on Rails application. You need to have installed following dependencies:

  • Ruby 1.9.2+ (Ruby 1.9.3 is recommended)
  • bundler gem gem install bundler
  • PostgreSQL 8+ with libpq development headers sudo apt-get install postgresql libpq-dev on Debian/Ubuntu

Also, for thumbnail generation you need following binaries:

  • tmux sudo apt-get install tmux on Debian/Ubuntu

  • scriptreplay sudo apt-get install bsdutils on Debian/Ubuntu

Get the source code

$ git clone git://github.com/sickill/ascii.io.git
$ cd ascii.io

Prepare DB config

Copy config/database.yml.example to config/database.yml. Then set database/user/password to whatever you prefer.

If database specified in database.yml doesn't exist then the following setup task will create it (make sure database user is allowed to create new databases).

Setup the app

$ ./script/setup

This will install gem dependencies and setup database.

Run

$ ./script/rails s

Authors

  • Marcin Kulik (sickill)
  • Michał Wróbel (sparrovv)