Skip to content

JoeReis/teleprompter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Simple Teleprompter

A simple, offline-first teleprompter application designed for use on an iPad or any other web browser. It's built as a Progressive Web App (PWA), which means you can add it to your home screen and use it even without an internet connection.

Features

  • Script Input: A large text area to paste or type your script.
  • Adjustable Scroll Speed: A slider to control how fast the text scrolls.
  • Adjustable Margins: A slider to control the left and right margins of the text.
  • Adjustable Focus Icon: A movable icon to help you keep your place while reading.
  • Offline Mode: Works as a PWA, so you can use it anywhere, anytime.
  • Responsive Design: The layout adjusts to fit your screen, whether it's in portrait or landscape mode.

How to Use

To use the teleprompter, you'll need to serve the files on a local network. Here’s how to do it on a Mac:

  1. Navigate to the Project Directory: Open the Terminal app and use the cd command to go to the directory where the index.html file is located.

    cd /path/to/your/project
  2. Start a Simple Web Server: Run the following command to start a basic web server.

    python3 -m http.server 8000

    If you get an "address is already in use" error, just use a different port number, like 8080.

  3. Find Your Computer's IP Address: Go to System Settings > Wi-Fi > Details..., and look for your IP Address. It will likely be something like 192.168.1.123.

On Your iPad

  1. Connect to the Same Wi-Fi: Make sure your iPad is on the same Wi-Fi network as your computer.
  2. Open Safari: Open the Safari browser.
  3. Go to the Address: In the address bar, type your computer's IP address, followed by the port number. For example: http://192.168.1.123:8000.
  4. Add to Home Screen: Tap the "Share" icon (a box with an arrow pointing up) and select "Add to Home Screen".
  5. Launch the App: You'll now have a "Teleprompter" icon on your home screen. You can open it just like a native app, and it will work even if you're offline.

Files

  • index.html: The main file that contains the HTML, CSS, and JavaScript for the application.
  • manifest.webmanifest: The web app manifest that allows the app to be installed on your home screen.
  • sw.js: The service worker that caches the app's files for offline use.
  • README.md: This file.

(Optional) For the best home screen icon, you can create two image files named icon-192.png (192x192 pixels) and icon-512.png (512x512 pixels) and place them in the same directory as the index.html file.

About

A simple web-based teleprompter app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published