Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akhtar21yr/realtime-feed-subscription
This repository contains a Django application for building a real-time feed subscription system. The system allows users to subscribe to channel groups and receive live feed updates using the Binance WebSocket API.
https://github.com/akhtar21yr/realtime-feed-subscription
Last synced: about 2 months ago
JSON representation
This repository contains a Django application for building a real-time feed subscription system. The system allows users to subscribe to channel groups and receive live feed updates using the Binance WebSocket API.
- Host: GitHub
- URL: https://github.com/akhtar21yr/realtime-feed-subscription
- Owner: Akhtar21yr
- License: gpl-3.0
- Created: 2024-03-22T12:24:15.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-24T08:51:11.000Z (9 months ago)
- Last Synced: 2024-05-14T12:24:44.454Z (7 months ago)
- Language: Python
- Homepage:
- Size: 163 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Real-Time Feed Subscription System with Django
This repository contains a Django application for building a real-time feed subscription system. The system allows users to subscribe to channel groups and receive live feed updates using the Binance WebSocket API.
## Features
1. **User Authentication:** Users can register and log in to the application.
2. **Subscription:** Upon logging in, users can subscribe to channel groups to receive live feed updates.
3. **WebSocket Integration:** Django Channels is used to handle WebSocket connections and send live feed messages to subscribed users.
4. **Scalability:** The application is designed to handle a large number of concurrent users subscribing to the feed.
## Technologies Used
- Python
- Django
- Django Rest Framework
- Django Channels
- Redis
## Installation
1. Clone this repository to your local machine:
```bash
git clone https://github.com/Akhtar21yr/RealTime-Feed-Subscription
cd realtime_feed_subscription
```
2. Install the required dependencies:
```bash
pip install -r requirements.txt
```
3. Set up PostgreSQL database according to settings in settings.py.
```bash
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': 'Enter Your Database Name',
'USER': 'Enter Your Username',
'PASSWORD': 'Enter You Password',
'HOST': 'localhost',
}
}
```
4. Apply migrations:
```bash
python manage.py makemigrations
python manage.py migrate
```
5. Run the development server:
```bash
python manage.py runserver
```
## Usage
1. **User Registration:** Navigate to `/api/register/` to register a new user by providing email, full name, age, and password.
**How to Use:**
- Add email, full_name, password, password2, age, city as a json data in Body/raw to register your self as a user.
```bash
{
"email":"[email protected]",
"full_name" : "admin",
"password":"admin",
"password2":"admin",
"age" : 21,
"city" : "mumbai"
}
```
- If everything is ok then is provide access and refresh token, copy the access token for further use.
2. **User Login:** Go to `/api/login/` to log in with the registered credentials.
**How to Use:**
- Add email, password in Body/raw as a json data to login in system.
```bash
{
"email":"[email protected]",
"password":"admin"
}
```
- If everything is ok then is provide access and refresh token, copy the access token for further use.
3. **Subscription:** After logging in, access ``/api/subscribe/`` to subscribe to channel groups for live feed updates.
**How to Use:**
- First Provide latest token in header `authorization` as key and `Bearer ` as a value.
.png)
- Provide gc_name as a json data in which group you want to subscribe.
```bash
{
"gc_name" : "binance"
}
```
- Make sure to subscribe `binance` group.
## WebSocket Connection Usage
**WebSocket connection:** established websocket connection to get the data from Binance at `ws://127.0.0.1:8000/ws/binance/` .
**How To Use:**
- First Provide token in header `authorization` as key and `Bearer ` as a value.
.png)
- Make sure you have already subscribed `binance` group.
- Connect to the websocket and enjoy real-time feed data from binance.