AdithyaSNair commited on
Commit
0c4e7a8
·
verified ·
1 Parent(s): df33714

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +70 -1
README.md CHANGED
@@ -4,9 +4,78 @@ emoji: ⚡
4
  colorFrom: blue
5
  colorTo: gray
6
  sdk: streamlit
7
- sdk_version: 1.39.0
8
  app_file: app.py
9
  pinned: false
10
  ---
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  colorFrom: blue
5
  colorTo: gray
6
  sdk: streamlit
7
+ sdk_version: 1.43.2
8
  app_file: app.py
9
  pinned: false
10
  ---
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
13
+
14
+ # Job Application Assistant
15
+
16
+ [![Streamlit](https://img.shields.io/badge/Streamlit-FF4B4B?style=for-the-badge&logo=Streamlit&logoColor=white)](https://streamlit.io)
17
+ [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
18
+
19
+ A Streamlit-based toolkit to streamline job applications. Includes email/cover letter generation, resume analysis, interview prep, and more.
20
+
21
+ ## Table of Contents
22
+
23
+ - [Features](#features)
24
+ - [Installation](#installation)
25
+ - [Configuration](#configuration)
26
+ - [Usage](#usage)
27
+ - [Modules](#modules)
28
+ - [Contributing](#contributing)
29
+ - [License](#license)
30
+
31
+ ## Features 🚀
32
+
33
+ | Tool | Description |
34
+ |--------------------------|-----------------------------------------------------------------------------|
35
+ | **Email Generator** | Create personalized cold emails using job postings and resumes. |
36
+ | **Cover Letter Creator**| Generate tailored cover letters for specific roles. |
37
+ | **Resume Analyzer** | Extract skills, ATS keyword suggestions, and visualize work experience. |
38
+ | **Application Tracker** | Manage job applications with a dashboard. |
39
+ | **Job Recommendations** | Get curated listings from Remotive, The Muse, and Indeed. |
40
+ | **Interview Prep** | Practice with AI-generated mock questions and answers. |
41
+
42
+ ## Installation 🛠️
43
+
44
+ ### 1. Clone the Repository:
45
+ ```bash
46
+ git clone https://github.com/your-username/job-application-assistant.git
47
+ cd job-application-assistant
48
+ ```
49
+
50
+ ### 2. Create a Virtual Environment (Optional):
51
+ ```
52
+ python -m venv venv
53
+ source venv/bin/activate # Linux/Mac
54
+ # venv\Scripts\activate # Windows
55
+ ```
56
+
57
+ ### 3. Install Dependencies:
58
+ ```
59
+ pip install -r requirements.txt
60
+ ```
61
+
62
+ ### Configuration ⚙️
63
+ Create a .streamlit/secrets.toml file with your API keys:
64
+
65
+ [GROQ_API_KEY]
66
+ value = "your_groq_api_key"
67
+
68
+ [RAPIDAPI_KEY]
69
+ value = "your_rapidapi_key"
70
+
71
+ [YOUTUBE_API_KEY]
72
+ value = "your_youtube_api_key"
73
+
74
+ ## Usage ▶️
75
+ Run the app:
76
+ ```
77
+ streamlit run app.py
78
+ and Access at
79
+ http://localhost:8501
80
+ ```
81
+