https://github.com/holedev/chat-server
Sercurity application, the message will be encode.
https://github.com/holedev/chat-server
Last synced: 28 days ago
JSON representation
Sercurity application, the message will be encode.
- Host: GitHub
- URL: https://github.com/holedev/chat-server
- Owner: holedev
- Created: 2023-03-04T13:31:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T02:06:37.000Z (about 2 years ago)
- Last Synced: 2025-01-07T13:38:56.181Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 95.7 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chat Server Application
A Flask-based chat server application with OAuth authentication, real-time messaging using SocketIO, and email notifications.
## Features
- User authentication with Google OAuth
- Real-time chat functionality using SocketIO
- Email notifications
- User profile management
- MySQL database integration
- Multilingual support (Vietnamese)
## Prerequisites
- Python 3.x
- MySQL Server
- SMTP server access (Gmail)
- Google OAuth credentials
## Installation
1. Clone the repository:
```bash
git clone
cd chat-server
```
2. Create and activate a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows use: venv\Scripts\activate
```
3. Install dependencies:
```bash
pip install -r requirements.txt
```
4. Configure environment variables:
- Copy `.env.example` to `.env`
- Update the following variables with your values:
```
SECRET_KEY=
NAME_DB=chat_server
PW_DB=
OAUTH_CLIENT_ID=
OAUTH_CLIENT_SECRET=
MAIL_USERNAME=
MAIL_PASSWORD=
```
5. Set up the MySQL database:
- Create a database named 'chat_server'
- Configure database credentials in `.env`
6. Configure OAuth:
- Set up a project in Google Cloud Console
- Create OAuth 2.0 credentials
- Add authorized redirect URIs:
- https://localhost:5001/callback
## Security Configuration
1. Enable HTTPS:
- SSL certificates are located in `chat_server/ssl/`
- Ensure valid certificates are in place
2. Environment Security:
- Never commit `.env` file
- Use strong, random SECRET_KEY
- Store sensitive credentials only in environment variables
- Use app-specific passwords for email services
## Running the Application
1. Start the server:
```bash
python -m flask run --port=5001 --cert=chat_server/ssl/cert.pem --key=chat_server/ssl/key.pem
```
2. Access the application:
- Open https://localhost:5001 in your browser
- Login with Google OAuth
## Project Structure
```
chat_server/
├── __init__.py # Application initialization
├── controllers.py # Route handlers
├── dao.py # Data access objects
├── decorators.py # Custom decorators
├── models.py # Database models
├── static/ # Static files (CSS, JS, images)
├── templates/ # HTML templates
└── ssl/ # SSL certificates
```
## Development Guidelines
1. Security:
- Always use HTTPS in production
- Keep dependencies updated
- Follow secure coding practices
- Never commit sensitive credentials
2. Code Style:
- Follow PEP 8
- Use meaningful variable names
- Add comments for complex logic
- Keep functions focused and modular