Share your WiFi network with your guests via QR!
WiFi QRedentials is a web application made with Python and HTML5. My initial motivation was to take a look at FastAPI by implementing a simple feature other than the well known Hello World.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Python 3.6 or greater
- virtualenv or your preferred tool to create isolated Python environments
- Clone this repository
[email protected]:FedericoJurio/wifiqredentials.git
- Access to the project directory
cd wifiqredentials
- Create a virtual environment
virtualenv -p python3 venv
- Activate the virtual environment
source venv/bin/activate
- Install the requirements
pip install -r requirements.txt
- Run the web application
uvicorn main:app
ZXing proposed a standardarized way to connect to WiFi via QR Codes.
This relies in the bar code scanner but most phones with Android 10/iOS 11 or greater should work.
Android phones usually don't come with a bar code scanner, you can install Barcode Scanner or NeoReader. OTOH, The iOS Camera App has support for WiFi QR codes since iOS 11.
No, never is a good idea to introduce secrets on a site that you can't trust. The app running on Heroku is the same that is on this repository but you can't verify it. If your WiFi password is not unique and you are reusing it for other stuff I'd recommend you to:
- Don't reuse passwords
- Run the app locally
There's room for improvements such as
- Adding unit tests
- Allowing the user to download the result as a friendly printable PDF
- Allowing the user to display the credentials as text as well in the result
- Adding a go back button in the result's page
- Making password field required for WPA/WPA2/WEP
There's a live demo hosted in Heroku.
Distributed under the MIT License. See LICENSE
for more information.