Hammad Wakeel commited on
Commit
599a7e8
Β·
unverified Β·
1 Parent(s): 7616a39

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +37 -8
README.md CHANGED
@@ -64,7 +64,37 @@ PORT=8000
64
  DEBUG=True
65
  ```
66
 
67
- ### 3. Run the Application
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
68
 
69
  ```bash
70
  # Option 1: Using the script
@@ -74,6 +104,11 @@ python run_server.py
74
  uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload
75
  ```
76
 
 
 
 
 
 
77
  ---
78
 
79
  ## πŸ“˜ API Overview
@@ -210,14 +245,8 @@ docker run -p 8000:8000 --env-file .env maas-api
210
 
211
  ---
212
 
213
- ## πŸ“œ License
214
-
215
- Licensed under the MIT License.
216
-
217
- ---
218
-
219
  ## πŸ”— Repository
220
 
221
- [https://github.com/Hammadwakeel/MAAS](https://github.com/Hammadwakeel/MAAS)
222
 
223
  ---
 
64
  DEBUG=True
65
  ```
66
 
67
+ ## 2. Create & Activate Virtual Environment
68
+
69
+ ### Windows (PowerShell)
70
+ ```powershell
71
+ # Create venv folder named `.venv`
72
+ python -m venv .venv
73
+
74
+ # Activate it
75
+ .venv\Scripts\Activate.ps1
76
+ ````
77
+
78
+ ### Linux / macOS (bash/zsh)
79
+
80
+ ```bash
81
+ # Create venv folder named .venv
82
+ python3 -m venv .venv
83
+
84
+ # Activate it
85
+ source .venv/bin/activate
86
+ ```
87
+
88
+ > **Tip:** On macOS you may need to run `chmod +x .venv/bin/activate` first if you get a permission error.
89
+
90
+ ### 3. Install Dependencies
91
+
92
+ ```bash
93
+ pip install --upgrade pip
94
+ pip install -r requirements.txt
95
+ ```
96
+
97
+ ## 4. Run the Application
98
 
99
  ```bash
100
  # Option 1: Using the script
 
104
  uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload
105
  ```
106
 
107
+ ```
108
+
109
+ You can adjust numbering to fit your existing sections. Let me know if you’d like any tweaks!
110
+ ```
111
+
112
  ---
113
 
114
  ## πŸ“˜ API Overview
 
245
 
246
  ---
247
 
 
 
 
 
 
 
248
  ## πŸ”— Repository
249
 
250
+ [https://github.com/Hammadwakeel/MAAS](https://github.com/Hammadwakeel/MAAS-FastAPI.git)
251
 
252
  ---