Giter Club home page Giter Club logo

simple-gource-launch's Introduction

PURPOSE

Generate movies of git repo activity by running a simple shell script requiring only one argument.

REQUIREMENTS

You must have already installed Docker. The movies are generated by a combination of cool open-source tools running in a docker container.

USAGE

Clone this repo and run the provided launch.sh script from your linux console. To view and download your movie, open the user interface at http://localhost:8080/ in your browser.

./launch.sh GIT_REPO_URL PROJECT_TITLE LOGO_URL
  • GIT_REPO_PATH = (REQUIRED) A local directory containing repo logs or a URL to a git repo.
  • PROJECT_TITLE = (OPTIONAL) text to appear as the title; defaults to git url.
  • LOGO_URL = (OPTIONAL) fully qualified url to logo; defaults to no logo.

EXAMPLE

  1. Launch script in console with the URL to the git repo you want to "film".

launch with params

  1. Verify the values when prompted; press ENTER key to kick off the show!

verification screen

  1. Wait for the gource application to finish making your mp4 movie. The browser at localhost:8080 will show a temporary message until the movie is ready.

browser movie not ready

  1. The console will show you when the film is ready.

console movie created message

  1. Watch the movie in the browser when ready.

watch in browser

  1. Download your mp4 movie by clicking the menu link in the lower right hand part of the browser page.

download the file from browser

SOURCE

Copy of entire source project copied from original author is in the Envisaged folder. Copy is from https://github.com/utensils/Envisaged

simple-gource-launch's People

Contributors

frankfont avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.