FedericoJurio / wifiqredentials

Share your WiFi network with your guests via QR!

Home Page:http://wifiqredentials.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Logo

WiFi QRedentials

Share your WiFi network with your guests via QR!

About the project

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.

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  1. Python 3.6 or greater
  2. virtualenv or your preferred tool to create isolated Python environments

Installation

  1. Clone this repository git@github.com:FedericoJurio/wifiqredentials.git
  2. Access to the project directory cd wifiqredentials
  3. Create a virtual environment virtualenv -p python3 venv
  4. Activate the virtual environment source venv/bin/activate
  5. Install the requirements pip install -r requirements.txt
  6. Run the web application uvicorn main:app

FAQ

How does this work?

ZXing proposed a standardarized way to connect to WiFi via QR Codes.

Is ZXing's standard supported by all the phones?

This relies in the bar code scanner but most phones with Android 10/iOS 11 or greater should work.

Should I use an specific app on my phone?

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.

Is it safe to put my secrets on the demo instance?

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:

  1. Don't reuse passwords
  2. Run the app locally

TODO

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

Demo

There's a live demo hosted in Heroku.

License

Distributed under the MIT License. See LICENSE for more information.

About

Share your WiFi network with your guests via QR!

http://wifiqredentials.herokuapp.com/

License:MIT License


Languages

Language:JavaScript 96.8%Language:HTML 1.4%Language:CSS 1.2%Language:Python 0.7%Language:Procfile 0.0%