https://github.com/ryuzinoh/flask-google-auth-module
flask module for email auths, [GMAIL authentication]
https://github.com/ryuzinoh/flask-google-auth-module
flask-auth gmail gmail-smtp
Last synced: 5 months ago
JSON representation
flask module for email auths, [GMAIL authentication]
- Host: GitHub
- URL: https://github.com/ryuzinoh/flask-google-auth-module
- Owner: RyuZinOh
- Created: 2024-12-15T18:38:52.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-15T18:57:53.000Z (7 months ago)
- Last Synced: 2024-12-15T19:39:15.407Z (7 months ago)
- Topics: flask-auth, gmail, gmail-smtp
- Language: Python
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Google OAuth Authentication with OTP Verification
This is a module to test and verify Google authentication for web applications, ensuring that only Gmail-confirmed accounts are able to authenticate and access services. This way, any random email addresses won't be verified without proper Gmail confirmation.
## How does it work?
1. Created an API service in the Google Developer Console.
2. Implemented the API routes provided by Google in Flask.
3. Set up SMTP mailing configuration in Gmail to verify users via OTP.
## How to use this module locally?
### Prerequisites
- Python 3.x
- A Gmail account (for sending OTP emails via Gmail's SMTP server)
- MongoDB installed locally or on a cloud provider like MongoDB Atlas
- A Google Developer Console project to generate OAuth 2.0 credentials
### Steps
#### 1. Clone the repository
Clone the project to your local machine:
```bash
git clone https://github.com/your-repo/google-oauth-otp.git
```
#### 2. Set up the Python environment
Create a virtual environment and activate it:
```bash
python -m venv venv
venv\Scripts\activate
```
Install the required dependencies:
```bash
pip install -r requirements.txt
```
#### 3. Set up Google OAuth credentials
generate client tokens ids, and keys frm the services apis, frm google console
#### 4. Set up the `.env` file
```ini
SECRET_KEY,
GOOGLE_CLIENT_ID,
GOOGLE_CLIENT_SECRET,
MAIL_USERNAME,
MAIL_PASSWORD,
MONGO_URI,
```
#### 5. run the application now.
``python app.py``