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 680d4bf96c Make player creation code more intention revealing 10 years ago
app Make player creation code more intention revealing 10 years ago
bin Refactor PNG generation 10 years ago
config Make all assets on S3 private by default 10 years ago
db Make all asciicasts private by default 10 years ago
lib Use warden scopes 10 years ago
public Improved left/right margin for guru meditation 10 years ago
script Install libtsm from "libtsm-3" tag 10 years ago
spec Use policy scope to decide which asciicasts should be listed 10 years ago
src Update terminal.c to work with latest libtsm 10 years ago
vendor There's no real need for Backbone here 10 years ago
.env.example
.gitignore
.rspec.example
.ruby-version Use ruby 2.1 in development 11 years ago
.travis.yml Don't test on rbx nor jruby 10 years ago
Gemfile Remove unused gems 10 years ago
Gemfile.lock Remove unused gems 10 years ago
Guardfile
LICENSE
Procfile
README.md Add PNG generation (https://asciinema.org/a/17654.png) 10 years ago
Rakefile
config.ru
sidekiq.ru

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 terminal sessions and sharing them on the web.

This is the source code of asciinema.org website. If you're looking for asciinema's terminal recorder go here: asciinema/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 private use or for your organization.

1. Install dependencies

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

  • Ruby 2.0+ (Ruby 2.1 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.

  • phantomjs 2.0+
    sudo add-apt-repository ppa:tanguy-patte/phantomjs && sudo apt-get update && sudo apt-get install phantomjs

2. Get the source code

Clone git repository:

$ git clone git://github.com/asciinema/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 asciicast pre-processing and 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-2015 Marcin Kulik. See LICENSE.txt for details.