VOREX - PROJECT

Vorex is a collaborative study platform designed to help students and learners connect, share study materials, and engage in discussions. It provides dedicated study rooms, chat functionality, quizzes, and gamification to enhance the learning experience.

Features

1. Rooms for Study Topics: Predefined admin rooms and user-created rooms for specific subjects.
2. Study Materials Upload: Share PDFs, notes, and other resources.
3. Chat System: Global, group, and private chat options.
4. Collaboration Tools: Invite friends to rooms and work together.
5. Search & Filters: Easily find rooms and materials.
6. Analytics & Progress Tracking: Track study sessions and engagement.

Tech Stack

1. Frontend: HTML, SCSS, JavaScript
2. Backend: Django
3. Database: PostgreSQL
4. Authentication: Django Authentication System, Oauth Authentication
5. Realtime Features: WebSockets for chat functionality

Installation

1. Clone the repository:
   • git clone https://github.com/charantm/vorex-project.git
   • cd vorex-project
2. Create a virtual environment and activate it:
   • python3 -m venv venv
   • source venv/bin/activate
3. Install dependencies:
   • pip install -r requirements.txt
4. Apply migrations:
   • python manage.py makemigrations
   • python manage.py migrate
5. Start the development server:
   • python manage.py runserver
6. Access the application at http://127.0.0.1:8000/

Contribution Guidelines

• Fork the repository and create a feature branch.
• Follow coding standards and document changes.
• Submit a pull request with clear commit messages.

License

• The project is Licensed Under GNU General Public License v3.0

⚡Reach out me here:

• LinkedIn
• Email