TekNotes

A Community-Driven Note-Sharing Platform

📄 Requirements · 📅 Gantt Chart · 🗄️ ERD · 🎨 Figma

TekNotes is a web-based platform designed to enhance collaboration and resource-sharing among students. Users can share, access, and collaborate on notes, study materials, and other academic resources — fostering a supportive learning environment that enriches the overall academic experience.

Built for CSIT327 Information Management 2

• 📝 Note sharing — create, publish, and browse community notes
• 💬 Real-time chat — WebSocket-powered direct messaging between users
• 🔔 Notifications — stay updated on activity relevant to you
• 🔍 Advanced search — find notes and users quickly
• 🏷️ Tags & courses — organize content by subject
• 🔐 OAuth login — sign in with Google or Microsoft via django-allauth

1. Copy the example environment file and fill in your values:

   cp .env.example .env

2. Start all services:

   docker compose up -d

   The app will be available at http://localhost:8000. Migrations and static file collection run automatically on startup.

Prerequisites: Python 3.12+, a running Redis instance (for WebSocket support)

1. Create and activate a virtual environment:

   # Linux / macOS
   python3 -m venv venv && source venv/bin/activate
   
   # Windows
   python -m venv venv && .\venv\Scripts\activate

2. Install dependencies:

   pip install -r requirements.txt

3. Copy and configure environment variables:

   cp .env.example .env
   # Edit .env — at minimum set DJANGO_SECRET_KEY

4. Apply migrations:

   python manage.py migrate

5. Start the development server:

   python manage.py runserver

   The app will be available at http://localhost:8000.

See .env.example for the full list. Key variables:

Please keep branch names descriptive and follow this structure to maintain consistency.

This project is open-source and available under the MIT License.