QR Generator is a simple, free, and open source QR code generator for your README
file. With this app, you can generate a QR code directly from your README
file. This app is build using python-qrcode with FastAPI and deployed on Vercel.
Using QR Generator, you can:
- Generate QR code with custom data.
- Costumize the QR code style, background color, and fill color.
Create your own QR code by modifying the DATA
and STYLE
in the URL below. You also can change the background color and fill color by changing the BG_COLOR
and FILL_COLOR
respectively. Curently there are 2 styles available: square
and circle
.
https://qr-generator-putuwaw.vercel.app/api?data=<DATA>&style=<STYLE>bg_color=<BG_COLOR>&fill_color=<FILL_COLOR>
Default style (transparent background and black fill color)
[![](https://qr-generator-putuwaw.vercel.app/api?data=https%3A%2F%2Fgithub.com%2Fputuwaw%2Fqr-generator&style=square)](https://qr-generator-putuwaw.vercel.app/api?data=https%3A%2F%2Fgithub.com%2Fputuwaw%2Fqr-generator&style=square)
Circle shape with blue background and white fill color
[![](https://qr-generator-putuwaw.vercel.app/api?data=https%3A%2F%2Fgithub.com%2Fputuwaw%2Fqr-generator&style=circle&bg_color=blue&fill_color=white)](https://qr-generator-putuwaw.vercel.app/api?data=https%3A%2F%2Fgithub.com%2Fputuwaw%2Fqr-generator&style=circle&bg_color=blue&fill_color=white)
Note
If you don't like to change the URL manually, you can use the QR Generator web app.
- Python 3.9 or higher
- Docker 24.0.4 or higher (optional)
- Clone the repository:
git clone https://github.com/putuwaw/qr-generator.git
- Create a virtual environment and activate it:
python3.9 -m venv venv
source venv/bin/activate
- Install the dependencies:
make install
- Run the application:
make run
- You can also run the application using Docker:
docker pull putuwaw/qr-generator
- Run the application on port
8000
:
docker run -p 8000:8000 putuwaw/qr-generator
Contributions are welcome! Please read the contributing guidelines first.
This project is licensed under the MIT License. See the LICENSE file for details.