asciinema hosting web app
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.
 
 
 
 
 
 
Go to file
Marcin Kulik 83f0a20e95 wip 10 years ago
app wip 10 years ago
config wip 10 years ago
db Rename nickname to username 10 years ago
doc Fresh Rails 3.1 app with DM 1.2 and RSpec 2.7 13 years ago
lib Use Warden for authentication 10 years ago
public Remove precompiled assets from public/ 11 years ago
script Fix travis setup 10 years ago
spec Namespace the existing API as v0 10 years ago
src Create bin dir when compiling terminal binary 11 years ago
vendor Move glyphicons from vendor/assets/fonts to app/assets/fonts 11 years ago
.env.example Unicorn with girl_friday on Heroku 12 years ago
.gitignore Use flat config files 11 years ago
.rspec.example Example .rspec config file 12 years ago
.ruby-version Use ruby 2.1 in development 10 years ago
.travis.yml Don't build on ruby 2.0 anymore 10 years ago
Gemfile wip 10 years ago
Gemfile.lock wip 10 years ago
Guardfile Replace zeus with spring 11 years ago
LICENSE.txt License 12 years ago
Procfile Make foreman start sidekiq with proper config file path 11 years ago
README.md Add coveralls badge to readme 10 years ago
Rakefile Change all occurrences of old project name to the new one 11 years ago
config.ru Load unicorn worker killer only in production 10 years ago
sidekiq.ru Add rake task for starting sidekiq web panel 11 years ago

README.md

asciinema.org

Build Status Code Climate Coverage Status

Record and share your terminal sessions, the right way.

Asciinema is a free and open source solution for recording the terminal sessions and sharing them on the web.

This is the source code of asciinema.org (formerly ascii.io) website and JS player. If you're looking for asciinema terminal recorder go here: sickill/asciinema

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.

1. Install dependencies

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

  • Ruby 1.9.3+ (Ruby 2.0.0-p247 is recommended)

  • bundler gem
    gem install bundler

  • PostgreSQL 8+ with libpq development headers
    sudo apt-get install postgresql libpq-dev on Debian/Ubuntu

  • libtsm
    See here for installation instructions. If you don't install it now the setup script (point 4 below) will try to install it for you anyway.

2. Get the source code

Clone git repository:

$ git clone git://github.com/sickill/asciinema.org.git
$ cd asciinema.org

3. Prepare database config file

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).

4. Setup the app

Following script will install gem dependencies and setup database:

$ ./script/setup

5. Run Rails server

$ bundle exec rails server

6. Run the background job processor

The background job processor is needed for thumbnail generation.

$ bundle exec sidekiq

Contributing

If you want to contribute to this project check out Contributing page.

Authors

Developed with passion by Marcin Kulik and great open source contributors

Copyright © 2011-2014 Marcin Kulik. See LICENSE.txt for details.