Open-source Flask project that implements a simple authentication system using Flask-Login
library - Features:
- ✅
Up-to-date dependencies
- ✅ Authentication layer:
Flask-Login
- ✅ UI: Bootstrap5 via
CDN
- ✅ Free Support via
Email
andDiscord
.
Step #1 - Clone sources (this repo)
$ # Clone the sources $ git clone https://github.com/app-generator/sample-flask-auth-session.git $ cd sample-flask-auth-session
Step #2 - Create a virtual environment
$ # Virtualenv modules installation (Unix based systems) $ virtualenv env $ source env/bin/activate $ $ # Virtualenv modules installation (Windows based systems) $ # virtualenv env $ # .\env\Scripts\activate
Step #3 - Install dependencies
$ # Install requirements $ pip3 install -r requirements.txt
Step #4 - Set Up Environment
$ # Set the FLASK_APP environment variable $ (Unix/Mac) export FLASK_APP=run.py $ (Windows) set FLASK_APP=run.py $ (Powershell) $env:FLASK_APP = ".\run.py"
Step #5 - Create Tables (SQLite persistance)
$ # Create tables $ flask shell $ >>> from app import db $ >>> db.create_all()
Step #6 - (optional) Enable DEBUG Environment (local development)
$ # Set up the DEBUG environment $ # (Unix/Mac) export FLASK_ENV=development $ # (Windows) set FLASK_ENV=development $ # (Powershell) $env:FLASK_ENV = "development"
Step #7 - Start the project
$ # Run the application $ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1) $ # --port=5000 - specify the app port (default 5000) $ flask run --host=0.0.0.0 --port=5000 $ $ # Access the app in browser: http://127.0.0.1:5000/
The project has a super simple structure, represented as bellow:
< PROJECT ROOT > | |-- app/ | |-- static/ | | |-- <css, JS, images> # CSS files, Javascripts files | | | |-- templates/ | | | | | |-- index.html # Index File | | |-- login.html # Login Page | | |-- register.html # Registration Page | | | | | config.py # Provides APP Configuration | forms.py # Defines Forms (login, register) | models.py # Defines app models | views.py # Application Routes | |-- requirements.txt |-- run.py | |-- ************************************************************************
- Free Admin Dashboards - index provided by AppSeed
- Flask Social Login - blog article (includes a free sample)
Flask User Authentication - Free sample provided by AppSeed.