Welcome to the JUST_CHAT Backend, the backbone of our real-time chatting application. This app provides a robust API and handles all server-side operations to support seamless communication.
Gerald Onyeka Ujowundu
Email: geraldrolland123@gmail.com
The backend enables the following functionalities:
- User Management: Secure user registration, authentication, and login.
- Real-Time Communication: Powered by WebSocket for instant messaging.
- File Sharing: Handles file uploads (PDFs, images, and voice notes).
- Group Chats: APIs to create, manage, and interact with group chats.
- Notifications: Sends real-time notifications for messages and events.
- Django Rest Framework (DRF): For building the API backend.
- Celery: For asynchronous tasks like notifications and file processing.
- MySQL: Relational database for data storage.
- WebSocket: Enables real-time communication.
Follow these steps to set up the backend locally:
- Python: v3.9+
- db.sqlite: v8+
- Docker (optional): For containerized deployment.
- Clone the repository:
git clone https://github.com/your-repo-url/justChat_backend.git
Create a virtual environment and activate it:
python3 -m venv venv
source venv/bin/activate
Install dependencies:
pip install -r requirements.txt
Configure your .env file with the following details: makefile
SECRET_KEY=your_secret_key DATABASE_NAME=just_chat_db DATABASE_USER=root DATABASE_PASSWORD=password DATABASE_HOST=localhost DATABASE_PORT=3306 Run migrations and start the server:
python manage.py migrate python manage.py runserver
To contribute:
Fork the repository. Create a new branch for your feature or bug fix. Submit a pull request with a detailed description of your changes.
Contact the developer for licensing information.