Skip to content
habitual69 edited this page May 1, 2023 · 1 revision

Welcome to the speakify wiki!


Speakify GitHub Wiki

Welcome to the Speakify GitHub Wiki. This page provides information about the Speakify web application and how to use it.

What is Speakify?

Speakify is a web application that uses Edge TTS to convert text to speech using a variety of voices. It is built using Python and Flask framework.

Demo Site

You can check out the demo site of Speakify by visiting https://speakify.vpms.xyz.

Installation

To run the Speakify app locally, you'll need to have Python 3.9 and pip installed on your machine. Here are the steps to install and run the app:

  1. Clone the project repository to your local machine.
  2. Open the terminal and navigate to the project folder.
  3. Install the required Python packages by running the following command:
pip install -r requirements.txt

Usage

To start the Speakify app, run the following command in the terminal:

python3 main.py

This will start the app server and automatically reload the server whenever changes are made to the Python code. You can access the app by visiting http://localhost:8000 in your web browser.

Docker

Alternatively, you can run the Speakify app using Docker. Here are the steps to build and run the Docker image:

  1. Navigate to the project folder and run the following command to build the Docker image:
docker build -t speakify .
  1. Once the image has been built, start a container from it with:
docker run -p 8000:8000 speakify

This will start a new container and map port 8000 in the container to port 8000 on your local machine. You can access the app by visiting http://localhost:8000 in your web browser.

Contributing

If you'd like to contribute to Speakify, please fork the repository, make your changes, and submit a pull request. We welcome contributions of all kinds, including bug fixes, feature additions, documentation improvements, and more.

Credits

Speakify was created by [habitual69]. The app uses Edge TTS for text-to-speech conversion.

License

Speakify is licensed under the MIT License.