Skip to content

ashreyasureddy/MenuQR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

MenuQR πŸ½οΈπŸ“±

MenuQR is a Django-based web application that allows restaurants to generate QR codes from their menu URLs. The generated QR code can be previewed and downloaded, helping restaurants provide contactless digital menus.


✨ Features

  • πŸ”— Generate QR codes from restaurant menu URLs
  • πŸ‘€ Preview QR code instantly
  • πŸ“₯ Download QR code as an image
  • πŸͺ Useful for restaurants, cafΓ©s, and food outlets
  • ⚑ Simple and lightweight Django application

πŸ›  Tech Stack

  • Python
  • Django
  • qrcode
  • Pillow
  • HTML, CSS, Bootstrap

πŸš€ Setup Instructions

Follow the steps below to run the project locally.

1️⃣ Clone the Repository

git clone https://github.com/your-username/MenuQR.git
cd MenuQR

2️⃣ Create a Virtual Environment

python -m venv env

3️⃣ Activate the Virtual Environment

Windows

env\Scripts\activate

macOS / Linux

source env/bin/activate

4️⃣ Install Dependencies

pip install django qrcode pillow

5️⃣ Run Database Migrations

python manage.py migrate

6️⃣ Start the Development Server

python manage.py runserver

Open your browser and visit:

http://127.0.0.1:8000/

πŸ§‘β€πŸ³ How to Use

  1. Open the application in your browser
  2. Enter the restaurant name
  3. Enter the menu URL
  4. Click Generate QR Code
  5. Preview the generated QR code
  6. Click Download QR Code to save the image

πŸ“‚ Project Structure

MenuQR/
β”œβ”€β”€ django_qr/                     # Main Django app
β”‚   β”œβ”€β”€ migrations/
β”‚   β”œβ”€β”€ __init__.py
β”‚   β”œβ”€β”€ admin.py
β”‚   β”œβ”€β”€ apps.py
β”‚   β”œβ”€β”€ forms.py
β”‚   β”œβ”€β”€ models.py
β”‚   β”œβ”€β”€ tests.py
β”‚   β”œβ”€β”€ urls.py
β”‚   β”œβ”€β”€ views.py
β”‚   └── templates/                 # HTML templates
β”‚       └── django_qr/
β”‚           β”œβ”€β”€ generate_qr_code.html
β”‚           └── qr_result.html
β”‚
β”œβ”€β”€ media/                         # contains demo menu images and generated QR code images
β”‚   β”œβ”€β”€ demo_restaurant_menu.png
β”‚   └── paradise_restaurant_menu.png
β”‚
β”œβ”€β”€ screenshots/                   # README screenshots
β”‚   β”œβ”€β”€ home.png
β”‚   └── qr_result.png
β”‚
β”œβ”€β”€ db.sqlite3
β”œβ”€β”€ manage.py
β”œβ”€β”€ requirements.txt
β”œβ”€β”€ README.md
└── LICENSE

ℹ️ Notes

Note:
The media/ directory is used to store runtime-generated files such as QR code images.
It is excluded from version control via .gitignore and is created automatically when the app runs.

Demo screenshots shown above are stored in the screenshots/ directory, not in media/.


πŸ“Έ Screenshots

Home Page

Home Page

Generated QR Code

QR Result


πŸ§ͺ Example

Sample menu URL:

https://drive.google.com/file/d/1i63ZJi5LKJSWP6zniCnkbstCNId8x_d_/view

πŸ›£οΈ Future Enhancements

  • 🎨 Custom QR colors and logos
  • πŸ“Š QR scan analytics
  • πŸ‘€ User authentication
  • 🌍 Multi-language support

πŸ“„ License

This project is licensed under the MIT License.


About

MenuQR πŸ½οΈπŸ“± | Django web app to generate QR codes for restaurant menus, preview and download QR codes for contactless digital menus.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors