Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sachnaror/chatapi
This Django Chat App demonstrates real-time communication using Django Channels and WebSockets. It's a showcase project for those interested in building live interactive features into their web applications, leveraging the power of Django and Redis.
https://github.com/sachnaror/chatapi
chat chat-application chatbot chatgpt-api
Last synced: about 2 months ago
JSON representation
This Django Chat App demonstrates real-time communication using Django Channels and WebSockets. It's a showcase project for those interested in building live interactive features into their web applications, leveraging the power of Django and Redis.
- Host: GitHub
- URL: https://github.com/sachnaror/chatapi
- Owner: sachnaror
- Created: 2024-03-12T20:42:36.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-03-12T21:06:26.000Z (10 months ago)
- Last Synced: 2024-03-12T21:54:51.580Z (10 months ago)
- Topics: chat, chat-application, chatbot, chatgpt-api
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Django Chat App Project (Using Channels)
This project is a basic real-time chat application built using the Django framework and Django Channels. It showcases the use of WebSockets for real-time communication between clients and server.
## Getting Started
These instructions will guide you through setting up the project on your local machine for development and testing purposes.
### Prerequisites
Before you start, ensure you have installed:
- Python 3.8 or higher
- Redis 5.0 or higher
### Setting Up the Development Environment
1. **Clone the Repository**
```bash
git clone https://github.com/sachnaror/ChatAPI
cd ChatAPI
```
2. **Create and Activate a Virtual Environment**
- For Unix or MacOS:
```bash
python3 -m venv venv
source venv/bin/activate
```
- For Windows:
```bash
python -m venv venv
.\venv\Scripts\activate
```
3. **Install the Requirements**
```bash
pip install -r requirements.txt
```
4. **Database Migrations**
Apply the database migrations to your local database.
```bash
python manage.py migrate
```
5. **Run the Redis Server**
Ensure the Redis server is running on your local machine. This project assumes Redis is running on its default port (6379).
```bash
redis-server
```
6. **Start the Django Development Server**
```bash
python manage.py runserver
```
7. **Access the Application**
Open your web browser and navigate to to start using the chat application.
## Acknowledgments
- **Django Channels** for providing the real-time WebSocket communication framework.
- **Redis** for the efficient messaging and storage solution.
```