Merge branch 'main' of https://github.com/sunithalv/ATS-Crewai

README.md

@@ -1,3 +1,16 @@
+---
+title: CrewAI ATS Resume Screener Rewriter
+emoji: 🐨
+colorFrom: blue
+colorTo: red
+sdk: streamlit
+sdk_version: 1.42.0
+app_file: app.py
+pinned: false
+license: apache-2.0
+short_description: Resume Screener Rewriter using CrewAI flow
+---
+
 # CrewAI ATS Resume Screener & Rewriter
 
 An AI-driven system built using CrewAI to streamline both employer-side candidate screening and candidate-side resume optimization for Applicant Tracking Systems (ATS).
@@ -39,11 +52,20 @@ git clone https://github.com/sunithalv/ATS-Crewai.git
 
 # Install dependencies using uv
 uv venv  # creates a virtual environment and activates it
-uv pip install -r requirements.txt
+uv pip install -e .
 ```
 
 > Note: Python version must be >= 3.11 and < 3.12
 
+## ▶️ Run the Application
+
+Launch the app locally using Streamlit:
+
+```bash
+streamlit run app.py
+```
+
+> The UI will open in your browser at `http://localhost:8501`
 
 ## 📧 Gmail Integration
 
@@ -56,10 +78,15 @@ Create a `.env` file in the root directory with:
 ```
 EMAIL_ADDRESS=your-email@gmail.com
 EMAIL_PASSWORD=your-app-password
+FIRECRAWL_API_KEY=your-firecrawl-api-key
 ```
 
-> ⚠️ **Important**: You must use a **Gmail App Password** if you have 2-Step Verification enabled.  
-> Learn how to generate one: [Google App Passwords](https://support.google.com/accounts/answer/185833)
+> ⚠️ **Important**:  
+> You must use a **Gmail App Password** if you have 2-Step Verification enabled.  
+> Learn how to generate one: [Google App Passwords](https://support.google.com/accounts/answer/185833)  
+>  
+> Get your **Firecrawl API key** from [firecrawl.dev](https://firecrawl.dev) to enable parsing job descriptions from URLs.
+
 
 ### ✉️ Sending Emails