Crowdsourced Study Notes Platform

Introduction

This is a crowdsourced study notes platform empowering students to share and access high-quality academic resources. It fosters collaboration, enabling peer-to-peer learning and creating a comprehensive repository for diverse subjects. Together, we make studying more effective and accessible for everyone in the university.

Objective

To design and implement a dynamic crowdsourced platform that empowers university students to share, access, and contribute study notes. This platform aims to foster a culture of peer-to-peer learning and collaboration by providing a centralized repository of diverse, high-quality academic resources. By leveraging the collective knowledge and efforts of students, the platform seeks to enhance learning outcomes, promote inclusivity in education, and create an engaging and supportive academic environment where students can thrive together.

Scope of Work

The Crowdsourced Study Notes Platform project aims to develop a user-friendly, collaborative web and mobile application that facilitates sharing and accessing academic resources. The scope of work includes the following deliverables:

1. User Management and Authentication: a) Develop secure user authentication and authorization features, including:
   i) Registration and login for students.
   ii) Role-based access control (e.g., admin for moderation).
   

2. Core Features:
   a) Upload and Download Resources:
   i) Enable users to upload study materials, previous year papers, and notes.
   ii) Provide a mechanism for users to download shared resources.
   iii) Security: A person cannot share personal data like photo personal or personal video.
   b) Search and Filter Functionality:
   i) Implement a search bar with filters for subject, course, semester, or year.
   c) Content Organization:
   i) Organize resources by categories such as department, subject, and semester.Organize resources by categories such as department, subject, and semester.
   d) Crowdsourcing Features:
   i) Allow users to upvote, rate, and comment on uploaded materials to improve content quality.
   

3. Administrative Panel
   a) Build an admin dashboard for:
   i) Moderating user-uploaded content to ensure appropriateness.
   ii) Managing categories, subjects, and flagged materials.
   

4. File Management and Storage
   a) Local Development Environment:
   i) Store uploaded files locally.
   b) Cloud store to store files.
   

5. Backend Development
   a) Django
   i) File upload/download.
   ii) Ratings and comments.
   iii) Search and filtering.
   

6. Database Design and Integration
   a) Design relational schemas for MySQL to store:
   i) User data, file metadata, and ratings.
   b) Integrate with MongoDB for flexible metadata handling if needed.
   

7. Crowdsourcing Enhancements
   a) Enable user interaction with features like:
   i) Ratings to highlight useful materials.
   ii) Comments for feedback and collaboration.
   iii) Submission tracker using activity_visualizer
   

User Management

1. Define two primary user roles:
   a) Student: Can upload, download, and rate study materials.
   b) Admin: Responsible for moderating content, managing categories, and addressing flagged uploads.
   
2. Analytics for Admins:
   a) Active users on the platform.
   b) Number of new registrations.
   c) Popular materials and categories.
   

Sample Requisition

1. user_id: A unique identifier for each user.
   
2. name: Full name of the user.
   
3. email: Registered email address for login and communication.
   
4. password: The hashed password for secure authentication.
   
5. role: Defines the user's role (e.g., "student" or "admin").
   
6. profile_picture: URL for the user’s profile image.
   
7. created_at / updated_at: Timestamps for when the user account was created or last updated.
   
8. activity: Tracks user actions, including uploads, ratings, and comments.
   
9. notifications_enabled: A boolean field to manage email or in-app notifications.
   

Search Sample

1. Request Fields:
   i) query: The search term entered by the user.
   ii) filters: Specific criteria for narrowing results (e.g., subject, semester, department).
   iii) sort_by and order: Options to organize results (e.g., by rating or upload date).
   iv) page and results_per_page: Pagination settings for navigating large datasets.
   

2. Response Fields: i) total_results: Total number of matching entries.
   ii) current_page: Current page number.
   iii) results_per_page: Number of results displayed on the current page.
   iv) results: A list of matching files with details like:
   v) File metadata (e.g., title, description, subject, semester, department).
   vi) Uploader information and file access link.
   vii) Engagement metrics (e.g., rating and downloads).
   

Report Generation & Download Data

1. Report
   a) User Activity Report:
   User details, including uploads, downloads, ratings, and comments.
   b) Content Engagement Report:
   Performance of uploaded resources (e.g., views, downloads, ratings).
   c) Platform Analytics Report:
   Number of active users, total uploads, downloads, and category-specific stats.
   d) Custom Reports:
   Generated based on filters like date range, department, or subject.
   

2. Data a) In app content download Allow users to download study materials for offline use within the app while restricting access to raw files on their local storage.

Technology Used

1. HTML: HTML5
2. CSS: CSS3
3. JavaScript: ECMAScript 2024 (ES15)
4. Django: Version 5.1.5
5. Python: Version 3.12
6. Figma: Web-based application
7. Flutter: Version 3.10
8. MySQL: Version 8.1
9. MongoDB: Version 6.0

Additional Tools:

1. Bootstrap: Version 5.3
2. Git: Version 2.42
3. Photoshop Online: Web-based application for image editing