readthedocs · stuti-2005 · Apr 23, 2026 · Apr 23, 2026 · Apr 23, 2026 · Apr 23, 2026
diff --git a/.DS_Store b/.DS_Store
diff --git a/docs/source/components.rst b/docs/source/components.rst
@@ -0,0 +1,23 @@
+Project Components
+==================
+
+Main Modules
+------------
+
+1. Identity Management Service
+   Handles Account creation, Login & Autheticaation, Password hashing & Verification
+
+2. Society Mangement Service 
+   Manages creating, updating, searching and deleting societies 
+
+3. Membership Service 
+   Handles Joining and Leaving societies 
+
+4. Event Service 
+   Manages joining and leaving events and display of events 
+
+5. Attendence Service 
+   Manages attendence count of number of people in a society and joining an event.
+
+7. Notification Service 
+   Manages RSVP perferences for upcoming events and information for joined society.
diff --git a/docs/source/generated/authentication.models.rst b/docs/source/generated/authentication.models.rst
@@ -0,0 +1 @@
+
diff --git a/docs/source/generated/authentication.serializer.rst b/docs/source/generated/authentication.serializer.rst
@@ -0,0 +1 @@
+
diff --git a/docs/source/generated/backend.authentication.models.rst b/docs/source/generated/backend.authentication.models.rst
@@ -0,0 +1 @@
+
diff --git a/docs/source/generated/backend.authentication.serializer.rst b/docs/source/generated/backend.authentication.serializer.rst
@@ -0,0 +1 @@
+
diff --git a/docs/source/generated/models.rst b/docs/source/generated/models.rst
@@ -0,0 +1 @@
+
diff --git a/docs/source/generated/serializer.rst b/docs/source/generated/serializer.rst
@@ -0,0 +1 @@
+
diff --git a/docs/source/generated/views.rst b/docs/source/generated/views.rst
@@ -0,0 +1 @@
+
diff --git a/docs/source/implementation.rst b/docs/source/implementation.rst
@@ -0,0 +1,37 @@
+Implementation
+==============
+
+Technologies Used
+----------------
+- Python (backend)
+- SQL Database
+- Dart/Flutter (frontend)
+- GitHub for version control
+
+Example Code
+------------
+
+.. code-block:: python
+
+   class User_ProfileView(APIView)
+
+    permission_classes = [IsAuthenticated]
+
+    def get(self, request):
+
+        user = request.user
+        serializer = UserSerializer(user)
+        return Response(serializer.data)
+
+    def post(self, request):
+
+        user = request.user
+        new_name = request.data.get("name")
+
+        if not new_name:
+            return Response({"error": "New name is required"}, status=400)
+
+        user.name = new_name
+        user.save()
+        return Response({"message": "Name changed successfully"})
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -17,6 +17,12 @@ Contents
 --------
 
 .. toctree::
+   :maxdepth: 2
+   :caption: Contents:
 
-   usage
+   scope
+   requirements
+   implementation
+   setup
+   components
    api
diff --git a/docs/source/models.py b/docs/source/models.py
diff --git a/docs/source/requirements.rst b/docs/source/requirements.rst
@@ -0,0 +1,57 @@
+User Requirements
+=================
+
+Functional Requirements
+----------------------
+- Users must be able to create an account using a secure registration process including email and password
+- Users should be able to join/leave societies
+- Users should be able to filter societies and view events clearly on a calendar interface for easy navigation. 
+- Users should be able to receive notifications for events and activities from societies they have joined
+- Users can opt in or out of receiving notifications for events and activities from the societies they have joined.
+- If a user leaves a society, they should no longer receive notifications.
+- Users should be able to sign in if they have forgotten their password.
+- Users should be able to see events for the society/societies they have joined
+- Users should be able to see a description and location of an event when they click on it
+
+
+Non-Functional Requirements
+--------------------------
+- The users' passwords must be securely hashed and never stored in plain text
+- Users should be able to communicate through a chat box with society's admins.
+- All user actions related to joining/leaving societies and changing notification preferences should be logged for audit
+purposes
+
+Admin Requirements 
+==================
+
+Functional Requirements
+----------------------
+- Admins should be able to place events/remove onto the main calendar page 
+- Admins should be able to track attendance
+- Admins should be able to create events
+- Admins should be able to remove events 
+- Admins should be able to update their profile data, including password changes and notification preferences. 
+- Admins should be able to edit/update event details 
+- Admins should be able to update their profile data, including password changes and notification preferences.
+- Admins should be able to manage society informatio
+- Admins should be able to set capacity limits
+- Admins should be able to generate or export attendance reports 
+
+System Requirements 
+===================
+
+Functional Requirements
+----------------------
+- The system will allow users to to create an account
+- The system will allow users and admins to log into the system
+- The system will not allow users to join a society they have already joined twice
+- The system will allow the user to unjoin a society if they wish to.
+- The system should provide a search and filter functionality to find societies by name, type, or category.
+- The system should be able to track membership status and allow users to view the societies they have joined.
+- The system must send notifications to users about events and activities for societies they have joined.
+- The system must display the availability of spaces for society events
+- The system shall provide an account settings interface that allows users to update their password and notification
+preferences.
+- The system shall provide an account management interface that allows administrators to update their credentials and
+notification preferences.
+
diff --git a/docs/source/scope.rst b/docs/source/scope.rst
@@ -0,0 +1,20 @@
+Project Scope
+=============
+
+This project aims to develop a system for University Students of Portsmouth University so they can access all society information.
+
+The system includes:
+- User side 
+- Admin side 
+- Event information
+- Live Analytics for admin society managment 
+- Featured and Top Societies 
+- Event Creation and Deletion 
+- Event and Society Browsing 
+
+
+Objectives
+----------
+- Improve Society engagement 
+- Track society engagement for admins 
+- Make Society events more accessible 
diff --git a/docs/source/serializer.py b/docs/source/serializer.py
diff --git a/docs/source/setup.rst b/docs/source/setup.rst
@@ -0,0 +1,135 @@
+Setup Instructions
+==================
+
+This project consists of a Flutter frontend and a Django REST backend.
+
+Requirements
+------------
+
+Make sure you have the following installed:
+
+Frontend:
+- Flutter SDK (>= 3.x)
+- Dart SDK (>= 3.9.0)
+
+Backend:
+- Python (>= 3.10)
+- PostgreSQL
+- Redis (for Celery background tasks)
+
+Tools:
+- Git
+
+Installation
+------------
+
+Clone the repository:
+
+.. code-block:: bash
+
+   git clone https://github.com/your-repo
+   cd your-repo
+
+-----------------------------------
+Backend Setup (Django REST Framework)
+-----------------------------------
+
+1. Create virtual environment:
+
+.. code-block:: bash
+
+   python -m venv venv
+   source venv/bin/activate  # Linux/Mac
+   venv\Scripts\activate     # Windows
+
+2. Install dependencies:
+
+.. code-block:: bash
+
+   pip install -r requirements.txt
+
+3. Configure PostgreSQL database:
+
+Update your database settings in ``settings.py``:
+
+- Database name: unisoc_db
+- User: unisoc_user
+- Password: strongpassword
+
+4. Apply migrations:
+
+.. code-block:: bash
+
+   python manage.py migrate
+
+5. Create superuser:
+
+.. code-block:: bash
+
+   python manage.py createsuperuser
+
+6. Run backend server:
+
+.. code-block:: bash
+
+   python manage.py runserver
+
+Backend runs at:
+http://127.0.0.1:8000/
+
+-----------------------------------
+Frontend Setup (Flutter)
+-----------------------------------
+
+1. Navigate to Flutter project:
+
+.. code-block:: bash
+
+   cd frontend   # adjust if different
+
+2. Install dependencies:
+
+.. code-block:: bash
+
+   flutter pub get
+
+3. Run the app:
+
+.. code-block:: bash
+
+   flutter run
+
+-----------------------------------
+Celery & Redis (Background Tasks)
+-----------------------------------
+
+Start Redis server:
+
+.. code-block:: bash
+
+   redis-server
+
+Start Celery worker:
+
+.. code-block:: bash
+
+   celery -A config worker --loglevel=info
+
+-----------------------------------
+Environment Variables (Important)
+-----------------------------------
+
+Update email configuration in ``settings.py``:
+
+- EMAIL_HOST_USER
+- EMAIL_HOST_PASSWORD
+
+⚠️ Do not expose real credentials in production.
+
+-----------------------------------
+Notes
+-----------------------------------
+
+- Ensure PostgreSQL is running before starting Django
+- Ensure Redis is running before starting Celery
+- Flutter app communicates with backend via API endpoints
diff --git a/docs/source/views.py b/docs/source/views.py