joramas/vcard-qr repository overview

⁠📱 vCard QR Code Generator 🔲

Generate personalized QR codes containing your contact information in vCard format! Perfect for business cards, social media profiles, or any situation where you want to share your contact details instantly! 🚀

⁠✨ Features

• 📝 Create detailed vCards with:
  • 👤 Basic contact information
  • 📞 Phone numbers
  • 📧 Email addresses
  • 🏢 Professional details
  • 📍 Address information
  • 🎂 Personal dates
  • 🌐 Social media links
• 🎨 Customize QR codes with your company logo
• 🖼️ Add profile photos
• ⬇️ Download QR codes instantly
• 🎯 Simple and intuitive web interface

⁠🛠️ Installation

1. Clone the repository:

   git clone https://github.com/yourusername/vcard-qr.git
   

   Copy

2. Install the required dependencies:

   pip install -r requirements.txt
   

   Copy

⁠Docker 🐳

This project supports Dockerization, allowing you to easily run the application in a containerized environment. You have two options:

⁠Option 1: Build the Docker Image Yourself

1. Build the Docker image:

   docker build -t vcard-qr .
   

   Copy

2. Run the Docker container:

   docker run -p 8501:8501 vcard-qr
   

   Copy

⁠Option 2: Use the Pre-built Docker Image

You can use the pre-built Docker image available on Docker Hub⁠:

1. Pull the Docker image:

   docker pull joramas/vcard-qr:latest
   

   Copy

2. Run the Docker container:

   docker run -p 8501:8501 joramas/vcard-qr:latest
   

   Copy

⁠🚀 Usage

1. Start the Streamlit app:

   streamlit run web.py
   

   Copy

2. Open your browser and navigate to the provided local URL 🌐

3. Fill in your contact details:

   • Required fields: Full Name and either Phone or Email 📝
   • Optional fields: Professional info, address, and more! ✨

4. Upload your logo (optional) 🎨

5. Click "Generate QR Code" and download your personalized QR code! ⬇️

⁠🔧 Technical Details

• Built with Python 3.x 🐍
• Uses Streamlit for the web interface 🖥️
• Powered by:
  • qrcode library for QR code generation
  • vobject for vCard creation
  • Pillow for image processing
  • Streamlit for the web interface

⁠🤝 Contributing

Contributions are welcome! Feel free to:

• 🐛 Report bugs
• 💡 Suggest new features
• 🔧 Submit pull requests

⁠📜 License

This project is licensed under the MIT License - see the LICENSE file for details. ⚖️

⁠📞 Contact

Have questions? Found a bug? Please open an issue! 🐞

---

Made with ❤️ by JOramas⁠