Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.93 KB

README.md

File metadata and controls

38 lines (24 loc) · 1.93 KB
Raw

ℹ️ This is the repo for the now outdated alpha version. I'm working on the final release, which will be vastly better suited for production use!

swiftube-banner

Swiftube

Swiftube is an innovative project that utilizes OpenAI and Remotion to transform content in text format, into polished explainer videos. It uses Google's text-to-speech feature to provide the voice for the video.

This project is built with a create-t3-app for frontend and an Express server for the backend (another repo).

Getting Started

To get started, follow these steps:

  1. Clone the repository to your local machine.
  2. Install dependencies using npm install.
  3. Add a .env file to the root of the project and include the necessary environment variables.
  4. Run the development server using npm run dev.
  5. Navigate to http://localhost:3000 in your web browser to use the application.

How it Works

Swiftube works by taking text input (prompt) from the user and utilizing OpenAI's APIs to generate talking points for the video. The script is then passed to Remotion, which generates the actual video with the help of Google's text-to-speech feature. The resulting video is then displayed to the user.

Contributing

Contributions are welcome and encouraged. If you would like to contribute, please follow these steps:

  • Fork the repository.
  • Create a new branch for your changes.
  • Make your changes and commit them with a descriptive message.
  • Push your changes to your fork.
  • Open a pull request to the main repository.

License

The source code in this repository is licensed under the MIT license. Remotion, a dependency of this project, uses the Remotion license. Note that for some entities a company license is needed. Read the terms here.