marouane53 / transcribe

MIT License
145 stars 68 forks source link

Integrate Docker Support, Environment Variable Management, and Enhance Security with .gitignore #6

Closed Marouan-chak closed 5 months ago

Marouan-chak commented 5 months ago

Summary

This PR introduces several enhancements to the Audio and Video Transcription Tool aimed at simplifying the setup process, securing API keys management, and ensuring a clutter-free repository. Key updates include Docker integration for ease of use, the adoption of environment variables for API key management through a .env file, and a .gitignore update to prevent accidental commits of sensitive data and the downloads directory.

Changes

Docker Integration: Added Docker support to containerize the application, streamlining the setup process and resolving dependency issues across different environments. Environment Variables for API Keys: Implemented the use of .env files for secure API key storage, accompanied by an .env.example template to guide users in setting up their own .env without risking exposure of sensitive information. .gitignore Update: Enhanced the .gitignore file to include the .env file and the downloads folder, protecting against the accidental commit of API keys and downloaded/transcribed files.

Impact

Simplified Setup: Users can now get the application up and running with Docker, eliminating the need to manually install dependencies. Enhanced Security: The use of .env files for API keys and updating .gitignore significantly reduces the risk of exposing sensitive information. Clean Repository: Excluding the downloads directory from commits keeps the repository clean and focused on source code.

geekloper commented 5 months ago

L3ez! I was just about to do that.

marouane53 commented 5 months ago

Great work man. Thank you

Marouan-chak commented 5 months ago

Great work man. Thank you

Happy to help anytime 🙌