BachelorsNest

BachelorsNest is a full-stack flat rental platform built for bachelors, property owners, and platform administrators. It helps bachelors discover approved rental properties, save listings, send rent requests, and chat with owners after requests are accepted. Owners can publish properties, manage listings, and approve or reject rent requests. Admins control users, properties, requests, notifications, security settings, and platform activity logs.

The application uses a Django REST backend and a React + Vite frontend. It is organized around three protected role areas: bachelor, owner, and admin.

Current Update Notes

• Media uploads are integrated with Supabase Storage through backend/backend/storage.py.
• Uploaded profile images and property images are stored in the configured SUPABASE_MEDIA_BUCKET.
• Current image URLs are generated as public Supabase object URLs by the Django storage backend.
• If the Supabase bucket is changed from public to private, property/profile images will not keep working without code changes.
• To support a private bucket, add Django media proxy endpoints or signed URL generation so Django can check permissions before returning files.
• Authentication remains Django/JWT based; Supabase Storage authenticated policies do not automatically understand these Django JWT users.
• Render deployment is configured by render.yaml with Django/Daphne, PostgreSQL, Redis, secure cookies, HSTS settings, and Supabase media variables.
• Frontend API calls continue to use VITE_API_URL and Axios token refresh through frontend/src/api/axios.js.

Table Of Contents

• Current Update Notes
• Screenshots
• Core Features
• Role-Based Access
• Tech Stack
• Project Structure
• Backend Apps
• Frontend Architecture
• API Overview
• Environment Variables
• Installation And Setup
• Testing And Verification
• Development Notes
• Deployment
• License

Screenshots

All screenshots are stored in Documentations/SystemImages.

Authentication

Bachelor Workspace

Owner Workspace

Admin Workspace

Chat

Core Features

Authentication And Accounts

• Register as a bachelor, owner, or admin.
• Login with JWT access and refresh tokens.
• Automatic access token refresh through Axios interceptors.
• Logout with token cleanup.
• Password reset request, token verification, and password reset confirmation.
• Profile view and update support.
• Role-aware redirects after login.
• Banned user protection during authentication.
• User activity logging for admin review.

Bachelor Features

• Browse approved rental properties.
• View property details and property images.
• Save and unsave properties through wishlist support.
• View saved properties.
• Send rent requests to property owners.
• Track rent request status.
• Cancel active rent requests when allowed.
• Receive request and platform notifications.
• Chat with owners after a rent request is accepted.
• View and edit profile.

Owner Features

• Owner dashboard with property and request summary.
• Add rental properties with image uploads.
• View own properties.
• Edit property details and images.
• Delete own properties.
• Track approval status of submitted properties.
• View incoming rent requests.
• Accept, reject, or cancel rent requests.
• Receive notifications for rent requests and saved properties.
• Chat with bachelors after a rent request is accepted.
• View and edit profile.

Admin Features

• Admin dashboard metrics.
• Manage users.
• Add users.
• Edit user data.
• Delete users.
• Ban and unban users.
• Change user roles between bachelor, owner, and admin.
• View user logs.
• Manage property approval workflow.
• Approve submitted properties.
• Reject submitted properties.
• Revert properties to pending.
• Edit properties.
• Delete properties.
• View all rent requests.
• View platform reports.
• Send broadcast notifications.
• Send role-based notifications.
• Send individual notifications.
• View notification/system logs.
• Manage security settings.

Property Management

• Property listing creation.
• Multiple image support.
• Owner-only property management.
• Admin approval workflow.
• Public approved-property browsing.
• Saved property/wishlist support for bachelors.
• Property availability and metadata support.

Rent Request Workflow

• Bachelor sends a request for a property.
• Duplicate active requests are blocked.
• Owner accepts or rejects requests.
• Accepted request can unlock chat between bachelor and owner.
• Status values include pending, accepted, rejected, and cancelled.
• Admin can view all rent requests.
• Request updates create notifications.

Chat And Messaging

• Chat users are based on accepted rent requests.
• Bachelors can chat with owners after an accepted request.
• Owners can chat with accepted bachelors.
• Conversation endpoint returns message history.
• Send message endpoint stores messages.
• Unread message count endpoint supports message badges.
• WebSocket consumer support exists for chat/status behavior.

Notifications

• User notification list.
• Mark notification as read.
• Notifications for rent request activity.
• Notifications for saved properties.
• Admin broadcast notifications.
• Admin role-based notifications.
• Admin individual notifications.
• Admin notification logs.

Security And Administration

• JWT authentication with refresh support.
• Role-guarded frontend routes.
• Backend permission checks.
• Admin security settings endpoint.
• User logs for login/admin activity.
• Banned-user handling.
• Password reset email support through SMTP or Resend configuration.

Role-Based Access

Public Routes

• /login
• /register
• /forget-password
• /reset-password/:token

Bachelor Routes

Protected by allowedRole="bachelor":

• /bachelor
• /bachelor/requests
• /bachelor/saved
• /bachelor/profile
• /bachelor/profile/:userId
• /bachelor/notifications
• /bachelor/chats

Owner Routes

Protected by allowedRole="owner":

• /owner
• /owner/requests
• /owner/notifications
• /owner/properties
• /owner/properties/add
• /owner/properties/edit/:id
• /owner/profile
• /owner/profile/:userId
• /owner/chats

Admin Routes

Protected by allowedRole="admin":

• /admin
• /admin/users
• /admin/properties
• /admin/requests
• /admin/reports
• /admin/notifications
• /admin/security
• /admin/settings
• /admin/profile
• /admin/profile/:userId

Tech Stack

Frontend

• React 19
• Vite
• React Router 7
• Tailwind CSS 3
• Axios
• JWT Decode
• Lucide React icons
• WebSocket client support

Backend

• Django 6
• Django REST Framework
• Simple JWT
• Django Filter
• Django CORS Headers
• Django Channels
• Channels Redis
• Daphne ASGI server
• WhiteNoise static file serving
• PostgreSQL
• Pillow
• Supabase storage integration
• Render backend hosting
• Vercel frontend hosting
• python-dotenv
• Requests

Project Structure

BachelorsNest/
  Documentations/
    SystemImages/

  backend/
    accounts/
    backend/
      settings.py
      urls.py
      asgi.py
      wsgi.py
    messaging/
    notifications/
    properties/
    rentals/
    build.sh
    manage.py
    requirements.txt
    runtime.txt
    .env.development.example
    .env.deployment.example

  frontend/
    src/
      api/
        adminPropertyApi.js
        adminSecurityApi.js
        adminUserApi.js
        authApi.js
        axios.js
        chatApi.js
        notificationApi.js
        propertyApi.js
        rentalApi.js
      components/
      context/
        AuthContext.jsx
        ThemeContext.jsx
      layouts/
        AdminLayout.jsx
        BachelorLayout.jsx
        OwnerLayout.jsx
      pages/
        admin/
        auth/
        bachelor/
        chat/
        owner/
        Profile.jsx
      routes/
        ProtectedRoute.jsx
      App.jsx
      main.jsx
    vercel.json
    .env.development.example
    .env.deployment.example
    package.json

  DEPLOYMENT.md
  README.md
  render.yaml

Backend Apps

accounts

Custom user model, registration, profile, JWT login behavior, password reset, owner/admin dashboards, user admin CRUD, role changes, ban toggle, user logs, and security settings.

properties

Property creation, owner property list, property update/delete, approved property browsing, admin property list, approval/rejection workflow, pending revert, saved properties, and wishlist toggle.

rentals

Rent request creation, bachelor request list, owner request list, admin request list, status updates, duplicate active-request prevention, and request deletion/cancellation.

messaging

Chat user discovery, conversation history, message sending, unread counts, and WebSocket consumer support.

notifications

User notifications, read state, admin broadcast messages, role-based notifications, individual messages, system logs, and admin user notification targeting.

Frontend Architecture

App.jsx

Defines public routes, bachelor routes, owner routes, admin routes, protected layouts, and fallback redirect behavior.

routes/ProtectedRoute.jsx

Loads the authenticated user from AuthContext and blocks access when the user is missing or the role does not match the route.

Layouts

• BachelorLayout.jsx for bachelor navigation and page shell.
• OwnerLayout.jsx for owner navigation and page shell.
• AdminLayout.jsx for admin navigation and page shell.

API Layer

Frontend API calls are split by domain:

• authApi.js
• propertyApi.js
• rentalApi.js
• chatApi.js
• notificationApi.js
• adminUserApi.js
• adminPropertyApi.js
• adminSecurityApi.js
• axios.js

axios.js centralizes the base API URL, JWT bearer token attachment, refresh token flow, and login redirect on expired sessions.

API Overview

Default backend URL:

http://localhost:8000

Default API base:

http://localhost:8000/api

Frontend environment variable:

VITE_API_URL=http://localhost:8000

Authentication And Accounts

Method	Endpoint	Purpose
POST	/api/token/	Login with JWT
POST	/api/token/refresh/	Refresh access token
POST	/api/accounts/register/	Register user
GET/PATCH	/api/accounts/profile/	Current user profile
GET	/api/accounts/users/<id>/	User details
POST	/api/accounts/logout/	Logout
POST	/api/accounts/password-reset/	Request password reset
POST	/api/accounts/password-reset-verify/	Verify reset token
POST	/api/accounts/password-reset-confirm/	Confirm password reset

Properties

Method	Endpoint	Purpose
GET	/api/properties/approved/	Approved public listings
GET	/api/properties/saved/	Bachelor saved listings
POST	/api/properties/<id>/wishlist/	Toggle saved property
POST	/api/properties/add/	Owner adds property
GET	/api/properties/owner/	Owner properties
PUT/DELETE	/api/properties/update-delete/<id>/	Update or delete property
GET	/api/properties/admin/all/	Admin property list
PATCH	/api/properties/approve/<id>/	Approve property
PATCH	/api/properties/reject/<id>/	Reject property
PATCH	/api/properties/revert-pending/<id>/	Revert to pending

Rent Requests

Method	Endpoint	Purpose
POST	/api/rentals/request/	Bachelor sends request
GET	/api/rentals/bachelor/	Bachelor requests
GET	/api/rentals/owner/	Owner requests
GET	/api/rentals/admin/	Admin request list
PATCH	/api/rentals/update/<id>/	Update request status
DELETE	/api/rentals/delete/<id>/	Cancel/delete request

Messaging

Method	Endpoint	Purpose
GET	/api/messages/users/	Users available for chat
GET	/api/messages/conversation/<user_id>/	Conversation history
POST	/api/messages/send/	Send message
GET	/api/messages/unread-count/	Unread count

Notifications

Method	Endpoint	Purpose
GET	/api/notifications/	Current user notifications
PATCH	/api/notifications/read/<id>/	Mark read
POST	/api/notifications/admin/broadcast/	Admin broadcast
POST	/api/notifications/admin/role/	Admin role notification
POST	/api/notifications/admin/individual/	Admin individual message
GET	/api/notifications/admin/logs/	System logs
GET	/api/notifications/admin/users/	Users for notification targeting

Admin Accounts And Security

Method	Endpoint	Purpose
GET	/api/accounts/admin/users/	Admin user list
POST	/api/accounts/admin/users/add/	Admin add user
PATCH/DELETE	/api/accounts/admin/users/<id>/	Edit/delete user
PATCH	/api/accounts/admin/users/<id>/ban/	Ban/unban user
PATCH	/api/accounts/admin/users/<id>/role/	Change role
GET	/api/accounts/admin/users/<id>/logs/	User logs
GET/PUT	/api/accounts/admin/security-settings/	Security settings
GET	/api/accounts/admin-dashboard/	Admin dashboard
GET	/api/accounts/owner-dashboard/	Owner dashboard

Environment Variables

Real .env files are ignored and should not be committed. Use .env.development.example for localhost and .env.deployment.example as the Render/Vercel variable template.

Backend Local Development

Copy the development example:

cd backend
copy .env.development.example .env

Local backend .env values:

DEBUG=True
SECRET_KEY=dev-only-secret-key
ALLOWED_HOSTS=localhost,127.0.0.1

POSTGRES_DB=BachelorsNest
POSTGRES_USER=postgres
POSTGRES_PASSWORD=your-local-password
POSTGRES_HOST=localhost
POSTGRES_PORT=5432

CORS_ALLOW_ALL_ORIGINS=True
CORS_ALLOWED_ORIGINS=http://localhost:5173,http://127.0.0.1:5173
CSRF_TRUSTED_ORIGINS=http://localhost:5173,http://127.0.0.1:5173
FRONTEND_URL=http://localhost:5173

SECURE_SSL_REDIRECT=False
SESSION_COOKIE_SECURE=False
CSRF_COOKIE_SECURE=False
SECURE_HSTS_SECONDS=0

SUPABASE_URL=
SUPABASE_KEY=
SUPABASE_MEDIA_BUCKET=StudyMaterials

Backend Production

Use backend/.env.deployment.example as the Render backend variable template. Render should use dashboard/Blueprint environment variables, not a committed .env file:

DEBUG=False
SECRET_KEY=replace-me-with-a-strong-secret
ALLOWED_HOSTS=your-backend.onrender.com,.onrender.com

DATABASE_URL=postgresql://user:password@host:5432/database
REDIS_URL=redis://host:6379

CORS_ALLOW_ALL_ORIGINS=False
CORS_ALLOWED_ORIGINS=https://your-frontend.vercel.app
CSRF_TRUSTED_ORIGINS=https://your-frontend.vercel.app
FRONTEND_URL=https://your-frontend.vercel.app

SESSION_COOKIE_SECURE=True
CSRF_COOKIE_SECURE=True
SECURE_SSL_REDIRECT=True
SECURE_HSTS_SECONDS=31536000

SUPABASE_URL=https://your-project.supabase.co
SUPABASE_KEY=your-supabase-key
SUPABASE_MEDIA_BUCKET=StudyMaterials

RESEND_API_KEY=
RESEND_FROM_EMAIL=onboarding@resend.dev

When DEBUG=False, the backend requires DATABASE_URL. On Render this is injected from the Render PostgreSQL database defined in render.yaml; without it, the backend intentionally refuses to start.

Frontend

Local frontend .env, copied from frontend/.env.development.example:

VITE_API_URL=http://localhost:8000

Use frontend/.env.deployment.example as the Vercel variable template:

VITE_API_URL=https://your-backend.onrender.com

The frontend derives WebSocket URLs from VITE_API_URL. Local HTTP uses ws://; production HTTPS uses wss://.

Installation And Setup

Prerequisites

• Python 3.11+
• Node.js 20+
• PostgreSQL
• Redis or Render Key Value for production WebSockets
• Supabase project/bucket for media storage

Backend Setup

cd backend
copy .env.development.example .env
python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver

Backend URL:

http://localhost:8000

Django admin:

http://localhost:8000/admin/

Frontend Setup

cd frontend
copy .env.development.example .env
npm install
npm run dev

Frontend URL:

http://localhost:5173

Production Build

cd frontend
npm run build

Optional ASGI/Daphne Run

cd backend
python -m daphne backend.asgi:application

Testing And Verification

Backend system check:

cd backend
python manage.py check

Backend production checks:

cd backend
python manage.py check --deploy
python manage.py makemigrations --check --dry-run
python manage.py collectstatic --noinput --dry-run

Frontend build:

cd frontend
npm run build

Frontend lint:

cd frontend
npm run lint

Useful route checks:

/login
/register
/bachelor
/owner
/admin
/admin/users
/admin/properties

Development Notes

• The frontend uses separate layouts for bachelor, owner, and admin areas.
• Route protection is role-based through ProtectedRoute.
• Axios automatically attaches JWT access tokens.
• Axios attempts token refresh on 401 responses.
• Chat access is based on accepted rent requests.
• Only approved properties are shown to bachelors.
• Property owners manage only their own listings.
• Admins can moderate users and properties across the platform.
• Supabase storage is used for uploaded media through the configured Django storage backend.
• Supabase object URLs are currently public URLs. Private-bucket support should be implemented through Django permission-checked media endpoints or signed URLs.
• Supabase Auth policies such as to authenticated do not apply to Django JWT users unless the app is redesigned to use Supabase Auth tokens for storage requests.
• Channels uses Redis when REDIS_URL is set and falls back to an in-memory layer for local development.

Deployment

Production and local development are separated by environment variables and separate services. Localhost work does not affect the production app unless you intentionally point local .env files at production URLs or databases.

Backend On Render

Render deploys only the Django backend. The repository root contains render.yaml because Render Blueprints are discovered from the root, but the service has rootDir: backend, so the React frontend is not built or deployed by Render.

Backend service settings:

Root directory: backend
Build command: bash build.sh
Start command: daphne backend.asgi:application -b 0.0.0.0 -p $PORT
Health check path: /health/

Required production services:

• Render Postgres, exposed as DATABASE_URL.
• Render Key Value/Redis, exposed as REDIS_URL, for Django Channels WebSocket support.

Frontend On Vercel

Vercel deploys only the React frontend. Set the Vercel project root directory to frontend; then Vercel reads frontend/vercel.json for SPA routing.

Frontend service settings:

Framework preset: Vite
Root directory: frontend
Build command: npm run build
Output directory: dist

Production frontend env:

VITE_API_URL=https://your-backend.onrender.com

For a more detailed checklist, see DEPLOYMENT.md.

Future Improvements

• Payment integration for deposits or booking fees.
• Rental agreement generation.
• Map-based property discovery.
• Advanced property filtering and recommendations.
• Owner verification and bachelor identity verification.
• Real-time notification transport.
• More detailed admin analytics.

License

MIT License. See LICENSE if present in the repository.

Support

If this project is useful, consider starring the repository and keeping the documentation up to date as features evolve.

Built With

• css
• html
• javascript
• python
• shell