Merge pull request #44 from oukookowa/tts_app

Text_to_speech app

Author: ianshulx

text_to_speech/.gitignore

@@ -0,0 +1,6 @@
+# Ignore environment files
+.env
+
+# Ignore compiled Python files
+*.pyc
+__pycache__/

text_to_speech/LICENSE

@@ -0,0 +1,19 @@
+# SPDX-License-Identifier: MIT
+
+MIT License
+
+Copyright (c) 2024 Ouko Okowa
+
+Permission Notice
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software under the following conditions:
+
+Conditions
+
+1. Attribution: Any distribution of the Software or derivative works must include the original copyright notice and this permission notice, giving appropriate credit to the original authors and contributors.
+
+2. Non-Commercial Use: The Software may not be used for commercial purposes without prior written permission from the copyright holder.
+
+3. Modification: If you modify the Software and distribute it, you must clearly state that the Software has been modified and provide a description of the changes made.
+
+4. No Warranty: The Software is provided "as is," without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability arising from the use of the Software.

text_to_speech/README.md

@@ -0,0 +1,47 @@
+# FreeTextToSpeechApp Documentation
+## version: 1.0.0
+
+## Overview
+In this project I demonstrate the use of Django Rest Framework to build an application API and how to seamlessly connect it to the frontend for amazing User Interface(UI). Included, is an integration of Google's Text-to-speech (gTTS) engine that leverages on AI to help convert texts to audio.
+
+## Authentication
+No authentication is set in this early version. The app allows you to write text and output it immediately as an audio output without needing to access the database.
+
+## Endpoints Overview
+
+### TextToSpeechView
+- **URL**: `/api/`
+- **Method**: `POST`
+- **Description**: Enter text using the form provided and submit it for real-time processing
+- **Request Body**:
+  ```json
+  {
+    
+    "text": "sample text",
+    
+  }
+  ```
+- **Response**: Returns a an audio file containing the converted text.
+
+
+## Example Usage
+### Convert TextToSpeech from your terminal
+```bash
+curl -X POST http://localhost:8000/api/ \
+     -H "Content-Type: application/json" \
+     -d '{
+           "text": "Hello, this is a test for text-to-speech conversion.",
+           "rate": 1.0,
+           "volume": 1.0,
+           "lang": "en"
+         }' \
+     --output output.mp3
+
+```
+
+## Error Codes
+- **400**: Bad Request — The request could not be understood or was missing required parameters.
+
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

text_to_speech/frontend/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

text_to_speech/frontend/README.md

@@ -0,0 +1,70 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+
+The page will reload when you make changes.\
+You may also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+
+If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
+
+You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+
+### Analyzing the Bundle Size
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
+
+### Making a Progressive Web App
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
+
+### Advanced Configuration
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
+
+### Deployment
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+
+### `npm run build` fails to minify
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)