Speekly 💬🎥

---

السَّلامُ عَلَيْكُم ورَحْمَةُ اللهِ وَبَرَكاتُهُ
Peace be upon you and the mercy of Allah and His blessings

Introduction

Imagine delivering a presentation, recording a video, or even holding a live stream, all while maintaining natural eye contact and smooth delivery – without memorizing a single word.

That's the power of a teleprompter, and with this innovative project, you can experience its benefits without breaking the bank or needing fancy equipment.

Say goodbye to expensive rigs and hello to a smarter prompting solution:

• Affordable and accessible: Forget about hefty price tags. This project brings teleprompting within reach for everyone, from aspiring YouTubers to seasoned professionals.
• Camera-agnostic: Ditch the limitations of traditional setups. This solution works seamlessly with any camera, even your laptop's built-in lens, giving you ultimate flexibility.
• Read with ease: Upload your script and watch it scroll smoothly on the screen, perfectly paced for your speaking rhythm. Maintain flawless eye contact with your audience, fostering a more natural and engaging connection.

Overview

A teleprompter serves as an invaluable tool for speakers during television or video production, allowing them to seamlessly deliver scripted content while maintaining eye contact with their audience or camera.

However, traditional teleprompters can be prohibitively expensive and may not be accessible to everyone, particularly when lacking a professional camera setup.

To address this challenge, I've developed this solution that simulates a real teleprompter, providing users with a user-friendly platform to upload their scripts.
The script is then displayed on the screen, enabling users to effortlessly read it while staying focused on the camera.

This project is not just a tool, it's an empowering platform for:

• Public speakers: Deliver impactful presentations with confidence and clarity.
• Content creators: Elevate your video productions to a professional level.
• Educators: Create engaging online courses and lectures.
• Anyone who wants to communicate effectively: From live streams to video meetings, this solution empowers you to connect with your audience on a deeper level.

Demo

demo_video.mp4

Technologies Used

Those are the main technologies used in this project:

Architecture

1. After uploading a script, the user initiates the process by clicking the "Start" button.
2. The main process launches a child process to run Vosk, triggered by an event listener for the click.
3. Vosk transcribes audio from the microphone, sending the results to the renderer process.
   The renderer process, equipped with an event listener, then compares the transcribed text with the uploaded script.

Installation

1. Make sure to have Node.js version 18.17.0 installed on your machine.
   You can install it using this link: https://nodejs.org/dist/v18.17.0/

2. Clone the repo from github using the following command

   git clone https://github.com/NidhalNaffati/smart-teleprompter.git

3. Install NPM packages

    cd smart-teleprompter && npm install

4. Install the Vosk model you want to use from https://alphacephei.com/vosk/models.
   for English speaker I highly recommend the vosk-model-en-us-0.22

5. Make sure to extract the model in the root directory of the project and rename it to model

Usage

1. Start the application with the following command

   npm run dev

2. Write the script you want to read in the text area
3. Click on the start button to start the process
4. Start reading the script and the application will highlight the words that you are reading

To Do

The upcoming features planned for implementation in this project include:

• Enable users to upload scripts from files 📁
• Provide users with the option to select models (languages) from a list 🌐
• Allow users to receive their transcriptions from the application, saved in a separate file 📝
• Enable users to record their own voice 🎙
• Implement the capability for users to record reading sessions as videos 📹
• Allow users to customize font size and script color 🎨
• Provide users with the ability to indicate problematic words during transcription

Contributing

We welcome contributions to enhance and improve this project. If you have ideas, bug fixes, or new features to suggest, please follow these steps:

1. Fork the repository.
2. Create a new branch for your contribution: git checkout -b feature/your-feature-name.
3. Implement your changes and ensure the code is well-documented.
4. Test your changes thoroughly.
5. Create a pull request, detailing the purpose and scope of your contribution.

Thank you for helping make this project better!