TheOpenPresenter
  • Introduction
    • Welcome
    • Motivation & Challenges
    • System Architecture
    • Terminologies
    • Server Communication
    • Project Topology
  • Development
    • Quickstart
    • Static files
    • Media Storage
  • Plugins
    • Introduction
    • Official Plugins
      • Google Slides
      • Lyrics Presenter
        • Lyrics compatibility
      • Video Player
      • Audio Recorder
    • Developing a Plugin
      • Plugin API
        • Yjs
          • Awareness
          • Scene
          • Renderer
        • Backend
          • Yjs Handler
          • Loading Frontend
          • Security
        • Frontend
          • Remote
          • Renderer
        • Media
          • Server Plugin API
          • Frontend
            • Tus
            • Form Data
        • TRPC
        • Database
      • Audio
      • Viewer State
      • Notifying Errors
      • Caveats
        • Sharing dependencies
        • Cross-over between plugins
      • Performance
  • API Reference
    • Plugin Context
  • Guide
    • Playing Audio
    • Listen to scene changes
  • Scratch Pad
    • Ambition
    • Background music
  • Environment Variables
  • External
    • Page 1
Powered by GitBook
On this page
  1. Development

Quickstart

PreviousProject TopologyNextStatic files

Last updated 7 months ago

The best way to understand the project is to just try it!

The project is open-source and we are looking for contributors.

Prerequisites

  • Docker & docker-compose

  • Node LTS & Yarn

Then, simply run these commands:

git clone git@github.com:Vija02/TheOpenPresenter.git

cd TheOpenPresenter

# Setup deps & envvars
yarn && yarn setup:env auto

# Run Database
docker-compose up -d

# Setup database
yarn setup:db

# Start the server
yarn dev

You should then be able to access the project through http://localhost:5678

If these steps doesn't work, please let us know!

GitHub - Vija02/TheOpenPresenter: TheOpenPresenter is an ambitious project aiming to be the final presenter software you'll ever needGitHub
Logo