Day 3: Readme Updated

Author: PTHARRISH

README.md

@@ -19,18 +19,18 @@ RO/
 ├── .github/
 │    └── workflows/
 │        └── pre-commit.yml            # CI for pre-commit hooks
-├── api/                     # URLs for API-only routing
+├── api/                               # API-only routing
 │   ├── __init__.py
 │   └── urls.py
 │
-├── backend/                          # Django project configuration
+├── backend/                           # Django project configuration
 │   ├── __init__.py
 │   ├── asgi.py
-│   ├── settings.py                   # Main project settings
-│   ├── urls.py                       # Root URL configuration
+│   ├── settings.py                    # Main project settings
+│   ├── urls.py                        # Root URL configuration
 │   └── wsgi.py
 │
-├── users/                            # App-level folder for user module
+├── users/                             # App-level folder
 │   ├── models.py
 │   ├── views.py
 │   ├── serializers.py
@@ -39,15 +39,15 @@ RO/
 │   └── ... (other app files)
 │
 ├── test/
-│   └── test_users.py                 # User-related unit tests
+│   └── test_users.py                  # Tests
 │
-├── .env                              # Environment variables
+├── .env                               # Environment variables
 ├── .gitignore
 ├── .pre-commit-config.yaml
 ├── .python-version
 ├── pyproject.toml
 ├── README.md
-├── requirements.txt                  # Project dependencies
+├── requirements.txt                   # Project dependencies
 ├── schema.yml
 └── uv.lock
 ```
@@ -66,19 +66,17 @@ This project uses **JWT Authentication** for secure and scalable user sessions.
   * Manage profile
   * View purifier products
   * Book installation or service
-
 * **Technician**
 
   * Login
   * View assigned service requests
   * Update work status
   * Check payment & service history
-
 * **Admin**
 
   * Manage all users & technicians
-  * View and deactivate user accounts
-  * Access all profiles and service/payment records
+  * View and deactivate accounts
+  * Access profiles and service/payment records
 
 ---
 
@@ -102,17 +100,53 @@ This project uses **JWT Authentication** for secure and scalable user sessions.
 
 * Manage all users & technicians
 * View all profiles
-* Deactivate/activate accounts
-* Track technician work and payments
+* Activate/Deactivate accounts
+* Track technician work & payments
 
 ---
 
 ## 🛠 Tech Stack
 
 * **Backend:** Django, Django REST Framework
 * **Authentication:** JWT
-* **Database:** PostgreSQL 
-* **Tools:** Pre-commit, GitHub Actions, uv package manager
+* **Database:** PostgreSQL
+* **Tools:** Pre-commit, GitHub Actions, **uv package manager**
+
+---
+
+## 🧰 Prerequisites for New Developers
+
+Before setting up the project, ensure the following are installed on your system:
+
+### ✔ Install Python
+
+This project uses the Python version defined in `.python-version`.
+If you don't have it installed, use **pyenv** or download the correct version manually.
+
+```
+# Example (using pyenv)
+pyenv install $(cat .python-version)
+pyenv local $(cat .python-version)
+```
+
+### ✔ Install uv (Python package manager)
+
+If uv is not installed, install it with:
+
+```
+pip install uv
+```
+
+(Or install via official instructions: [https://docs.astral.sh/uv/](https://docs.astral.sh/uv/))
+
+### ✔ Install PostgreSQL
+
+Download & install PostgreSQL from the official website.
+Create a database using the same name provided in your `.env` file:
+
+```
+createdb RO_db
+```
 
 ---
 
@@ -131,12 +165,18 @@ cd RO
 cp .env.example .env
 ```
 
-Update with your settings.
+Update values according to your setup.
 
-### 3️⃣ Install dependencies
+### 3️⃣ Install dependencies using uv
 
 ```
-pip install -r requirements.txt
+uv sync
+```
+
+(or install fresh)
+
+```
+uv pip install -r requirements.txt
 ```
 
 ### 4️⃣ Apply migrations
@@ -145,7 +185,7 @@ pip install -r requirements.txt
 python manage.py migrate
 ```
 
-### 5️⃣ Run the development server
+### 5️⃣ Start the development server
 
 ```
 python manage.py runserver
@@ -159,29 +199,67 @@ python manage.py runserver
 pytest
 ```
 
-Tests are located in `test/` directory.
+Tests are located inside the `test/` directory.
 
 ---
 
 ## 📄 API Documentation
 
 API schema is available in `schema.yml`.
-You can integrate with **Swagger**, **ReDoc**, or **Postman**.
+You may generate API docs using **Swagger**, **ReDoc**, or import into **Postman**.
 
 ---
 
-## 🤝 Contributing
+## 🧩 Sample `.env` File
+
+```
+SECRET_KEY=django-insecure-m72oe!!4!@1o)6b1-exojf1y1-4d+j%l+gmu5xv0dzf+a5ys$s
+DEBUG=True
+
+DB_NAME=RO_db
+DB_USER=postgres
+DB_PASSWORD=root
+DB_HOST=127.0.0.1
+DB_PORT=5432
+
+EMAIL_HOST=smtp.gmail.com
+EMAIL_PORT=587
+[email protected]
+EMAIL_HOST_PASSWORD=test
+```
+
+SECRET_KEY=django-insecure-m72oe!!4!@1o)6b1-exojf1y1-4d+j%l+gmu5xv0dzf+a5ys$s
+DEBUG=True
+
+DB_NAME=RO_db
+DB_USER=postgres
+DB_PASSWORD=root
+DB_HOST=127.0.0.1
+DB_PORT=5432
+
+RATE_LIMIT_ANON=100/hour
+RATE_LIMIT_USER=1000/hour
 
-Pull requests are welcome! Please ensure your code follows linting rules enforced by **pre-commit hooks**.
+EMAIL_HOST=smtp.gmail.com
+EMAIL_PORT=587
+EMAIL_HOST_USER=[[email protected]](mailto:[email protected])
+EMAIL_HOST_PASSWORD=test
+
+```
 
 ---
 
-## 📜 License
+## 🤝 Contributing
+Pull requests are welcome! Make sure all code follows linting rules enforced by **pre-commit hooks**.
+
+---
 
+## 📜 License
 This project is licensed under the MIT License.
 
 ---
 
 ## 📞 Support
-
 For any queries or issues, feel free to raise an issue in the repository.
+
+```