Giter Club home page Giter Club logo

autoshorts's Introduction

Autoshorts

๐Ÿš€ Running Locally

Prerequisites

  • Reasonably updated Node.js runtime installed
  • TypeScript package installed
  • Python 3.11 or later installed
  • ImageMagick installed

Instructions

  • git clone this repository or download as ZIP and extract it somewhere.
  • cd into the root directory of the project in a terminal.
  • npm run setup to install the required Python and Node.js packages.
  • npm start to start the webserver for the interface.
  • Go to localhost:8080 on your browser unless you have defined another port.
  • For chess videos, mark a move in your PGN as brilliant with !!, e.g Bxc3+!!.
  • Generated shorts are stored in the out directory, which you will find in the project folder.

๐Ÿ“œ NPM Scripts

npm run setup Installs required Python and NPM packages.
npm run build Compiles TypeScript for web interface.
npm start Compiles TypeScript and starts web interface on localhost.

๐Ÿ”‘ Environment Variables

PORT The port that the webserver running the interface listens on. Defaults to 8080.

autoshorts's People

Contributors

wintrcat avatar wilsoncrunden avatar dependabot[bot] 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.