Day 10: Updated Readme with Folder structure and freeze the requirements in txt file

Author: PTHARRISH

README.md

@@ -1,6 +1,10 @@
+<<<<<<< Updated upstream
 # Instagram Clone
+=======
+# Instagram Clone - User Microservice
+>>>>>>> Stashed changes
 
-A Django REST Framework microservice that handles all user-related functionalities similar to Instagram, including authentication, profiles, followers/following, blocking/muting, close friends, user settings, and permission management.
+A **Django REST Framework microservice** that handles all **user-related functionalities** similar to Instagram, including authentication, profiles, followers/following, blocking/muting, close friends, user settings, and role-based access control (RBAC). This microservice is built to be **scalable, modular, and microservice-ready**.
 
 ---
 
@@ -23,12 +27,12 @@ A Django REST Framework microservice that handles all user-related functionaliti
 - **List Following** (`FollowingView`)
 - **Follow/Unfollow Actions** (`FollowActionView`)
 - **Follow Requests** (`FollowRequestRespondView`)
-- Supports search and pagination.
+- Supports **search** and **pagination**.
 
 ### 4. Blocking & Muting
 - **Block Users** (`BlockedUser` / `BlockUserView`)
 - **Mute Users** (`MutedUser` / `MuteUserView`)
-- Granular mute options: posts and stories.
+- Granular mute options: **posts and stories**.
 
 ### 5. Close Friends
 - **Manage Close Friends** (`CloseFriend` / `CloseFriendView`)
@@ -79,12 +83,62 @@ A Django REST Framework microservice that handles all user-related functionaliti
 
 ---
 
-## Pagination
-- All list endpoints (followers/following) use `DefaultPagination`.
+## Pagination & Search
+- All **list endpoints** (followers/following) use **`DefaultPagination`**.
 - Search query supported via `?search=<term>`.
 
 ---
 
+## Notes
+- All non-public endpoints require authentication.
+- Privacy and visibility are enforced at the view-level using **DynamicPagePermission**.
+- RBAC allows admins to enable/disable features per URL without code changes.
+- Blocking and muting are supported at a granular level for posts and stories.
+
+---
+
+## Folder Structure
+
+```text
+Instagram-Clone/                      # Django project root
+│
+├── backend/
+│   ├── __init__.py
+│   ├── settings.py           # Global settings (JWT, DRF, throttling, caching)
+│   ├── urls.py               # Project-level URLs (admin + api)
+│   ├── asgi.py
+│   └── wsgi.py
+│
+├── api/                      # API gateway layer
+│   ├── urls.py               # Routes all app endpoints
+│   └── __init__.py
+│
+├── users/                    # User domain microservice
+│   ├── models.py             # User, Profile, Follow, Block, Mute, Settings
+│   ├── serializers.py
+│   ├── views.py
+│   ├── urls.py
+│   ├── tests/
+│   └── __init__.py
+│
+├── rbac/                     # Role-Based Access Control
+│   ├── models.py             # Role, PagePermission, UserPermission
+│   ├── serializers.py
+│   ├── permissions.py        # DynamicPagePermission
+│   ├── views.py
+│   ├── urls.py
+│   └── __init__.py
+│
+├── core/                     # Shared reusable components
+│   ├── models.py             # TimeStampedModel
+│   ├── pagination.py         # DefaultPagination
+│   ├── throttling.py         # Custom throttle classes
+│   └── __init__.py
+│
+├── manage.py
+└── requirements.txt
+
+
 ## Notes
 - All non-public endpoints require authentication.
 - Privacy and visibility are enforced at the view-level using `DynamicPagePermission`.

requirements.txt

@@ -0,0 +1,34 @@
+asgiref==3.11.0
+attrs==25.4.0
+colorama==0.4.6
+dill==0.4.0
+Django==4.2
+django-cors-headers==4.9.0
+django-jazzmin==3.0.1
+djangorestframework==3.16.1
+djangorestframework_simplejwt==5.5.1
+drf-spectacular==0.29.0
+inflection==0.5.1
+iniconfig==2.3.0
+isort==6.1.0
+jsonschema==4.25.1
+jsonschema-specifications==2025.9.1
+mccabe==0.7.0
+packaging==25.0
+pillow==12.0.0
+platformdirs==4.5.0
+pluggy==1.6.0
+psycopg2-binary==2.9.11
+Pygments==2.19.2
+PyJWT==2.10.1
+pylint-plugin-utils==0.9.0
+pytest==9.0.2
+pytest-django==4.11.1
+python-decouple==3.8
+PyYAML==6.0.3
+referencing==0.37.0
+rpds-py==0.30.0
+sqlparse==0.5.3
+tomlkit==0.13.3
+tzdata==2025.2
+uritemplate==4.2.0