This is a turnkey Flask app template that provides a starting point for building full-stack applications with authentication and authorization capabilities powered by Google Firebase and Firestore. No more wasted time from starting Flask applications from scratch. This template simplifies the development process with pre-built includes pre-built features including user authentication (signup and login with Google or email and password reset), session management, route authorization, all optimized for mobile viewing. All you need to do is clone with responsitory, follow the simple setup instructions for Firebase, and then you are ready to build your customized web application.
- Firebase Authentication Integration: Prebuilt login and signup with either email or Google account, and password reset.
- Firestore Database Integration: Easy setup to start using Firestore as your application database.
- Secure Cookie Handling: Client-side and server-side setup for secure cookie management.
- Page Authorization: Setup for page-specific authorization to protect routes.
- Responsive Design: A basic responsive navbar and optimized interfaces for mobile and desktop viewing.
- Pre-built Pages: Pre-configured pages and forms for authentication processes including login, signup, and password recovery.
Before you begin, ensure you have the following installed:
- Python 3.8 or later
- pip (Python package installer)
To get a local copy up and running follow these simple steps.
Youtube Tutorial Link: https://youtu.be/HoRutj1z3fQ?si=AqlPrnqYYt90DdKf
git clone https://github.com/adjdunn/simple_firebase_app cd flask-firebase-auth-template
pip install -r requirements.txt
- Create Firebase account (https://firebase.google.com/)
- Go to the Firebase Console.
- Add a new project.
- Add web app to project.
- Go to "Project Settings" > Scroll to "SDK setup and configuration" > Select "Config" radio button and copy "firebaseConfig" data.
- Paste "firebaseConfig" data into firebase-config.js file (located in static folder).
- Paste "firebaseConfig" data into firebase-config.py file (adjust format to make it a valid python dict).
- Navigate to the "Firestore Database" section and create your database (if required for your project).
- Go to "Project Settings" > "Service accounts" > "Firebase Admin SDK" > Python option > click on the "Generate new private key" button > Download the JSON file.
- Place the downloaded JSON file in your project directory and rename it to firebase-auth.json.
- Navigate to "Buid" > "Authentication" section > click "Sign-in Method" and enable sign-in for Email/Password and Google options.
- Inside the "Autentication" section > click "Settings" > "Authorized Domains" and add your website domain to allow it to use the Google sign pop up in (localhost is authorized by default).
Create a .env file in the root directory of the project and add the following environment variables:
SECRET_KEY=add_your_secret_key_here
python app.py
This will start the Flask application on http://localhost:5000 by default.
To add private pages (requiring authentication to view) add the @auth_required decorator to the route.
Example:
@app.route('/dashboard') @auth_required def dashboard(): return "This is a private page that requires authentication to view"
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Fork the Project Create your Feature Branch (git checkout -b feature/AmazingFeature) Commit your Changes (git commit -m 'Add some AmazingFeature') Push to the Branch (git push origin feature/AmazingFeature) Open a Pull Request
Distributed under the MIT License.
Flask Firebase