Update README.md
Browse files
README.md
CHANGED
|
@@ -44,6 +44,15 @@ uv pip install -e .
|
|
| 44 |
|
| 45 |
> Note: Python version must be >= 3.11 and < 3.12
|
| 46 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 47 |
|
| 48 |
## 📧 Gmail Integration
|
| 49 |
|
|
@@ -56,10 +65,15 @@ Create a `.env` file in the root directory with:
|
|
| 56 |
```
|
| 57 |
EMAIL_ADDRESS=your-email@gmail.com
|
| 58 |
EMAIL_PASSWORD=your-app-password
|
|
|
|
| 59 |
```
|
| 60 |
|
| 61 |
-
> ⚠️ **Important**:
|
| 62 |
-
>
|
|
|
|
|
|
|
|
|
|
|
|
|
| 63 |
|
| 64 |
### ✉️ Sending Emails
|
| 65 |
|
|
|
|
| 44 |
|
| 45 |
> Note: Python version must be >= 3.11 and < 3.12
|
| 46 |
|
| 47 |
+
## ▶️ Run the Application
|
| 48 |
+
|
| 49 |
+
Launch the app locally using Streamlit:
|
| 50 |
+
|
| 51 |
+
```bash
|
| 52 |
+
streamlit run app.py
|
| 53 |
+
```
|
| 54 |
+
|
| 55 |
+
> The UI will open in your browser at `http://localhost:8501`
|
| 56 |
|
| 57 |
## 📧 Gmail Integration
|
| 58 |
|
|
|
|
| 65 |
```
|
| 66 |
EMAIL_ADDRESS=your-email@gmail.com
|
| 67 |
EMAIL_PASSWORD=your-app-password
|
| 68 |
+
FIRECRAWL_API_KEY=your-firecrawl-api-key
|
| 69 |
```
|
| 70 |
|
| 71 |
+
> ⚠️ **Important**:
|
| 72 |
+
> You must use a **Gmail App Password** if you have 2-Step Verification enabled.
|
| 73 |
+
> Learn how to generate one: [Google App Passwords](https://support.google.com/accounts/answer/185833)
|
| 74 |
+
>
|
| 75 |
+
> Get your **Firecrawl API key** from [firecrawl.dev](https://firecrawl.dev) to enable parsing job descriptions from URLs.
|
| 76 |
+
|
| 77 |
|
| 78 |
### ✉️ Sending Emails
|
| 79 |
|