Skip to content

Vikuuu/YET-ANOTHER-CHAT-APP-BACKEND

Repository files navigation

Yet Another Chat App

This project is a simplified version of Discord, built using Django Rest Framework (DRF). It serves as a backend for a chat application, providing endpoints for user management, friend interactions, and project-related functionalities.

Table of Content

  1. Feature
  2. Installation
  3. Usage
  4. API Endpoints
  5. Tasks

Feature

  • User Management: Register, login, and manage user accounts.
  • JWT Authentication: Secure endpoints using JWT tokens.
  • Docker Support: Easily deployable with Docker.

Installation

Using Docker

  1. Clone the repository:
git clone https://github.com/Vikuuu/discord-django-clone.git
cd discord-django-clone
  1. Build the Docker:
docker build
  1. Run the Docker:
docker-compose up
  1. Create a Superuser (optional):
docker-compose run --rm app sh -c "python manage.py createsuperuser"
  1. Stop the Docker:
    docker-compose down
    

Usage

Once the server is running, you cna access the API at http://127.0.0.1:8000/

  • User Endpoint: Register user, login user, logout user, etc.

You can explore the API using tools like Postman or Django's built-in browsable API.

Endpoints

Here's a list of API Endpoint:

  • POST /api/user/crete/ - Register User

  • POST /api/user/login/ - Login User

  • GET /api/user/profile/<str:username>/ - Get the Profile

  • PATCH /api/user/profile/<str:username>/ - Update user profile

  • POST /api/friend/send/<str:username>/ - Send Friend Request

  • POST /api/friend/accept/<str:username> - Accept Friend Request

You can view all the API endpoint's on this URL: Swagger API Docs

Added the Swagger Documentation.

swagger_page

Tasks

  • User Creation
  • User Authentication
  • User Profile View
  • Send Friend Request
  • Accept Friend Request
  • Adding Swagger
  • Chat with Friend
  • Create Server

About

Discord Clone using Django for Backend API's.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published