Niharmahesh commited on
Commit
e9ff746
Β·
verified Β·
1 Parent(s): 6db73c6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +72 -10
README.md CHANGED
@@ -1,13 +1,75 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: AI Job Search And Match
3
- emoji: πŸš€
4
- colorFrom: blue
5
- colorTo: purple
6
- sdk: streamlit
7
- sdk_version: 1.41.1
8
- app_file: app.py
9
- pinned: false
10
- short_description: An AI-powered job search assistant that analyzes resumes, ma
 
 
 
 
 
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
1
+
2
+
3
+
4
+ # AI-Job-Search and Match
5
+
6
+ An AI-powered job search assistant that analyzes resumes, matches job listings, and provides intelligent job search insights.
7
+
8
+ ## Features
9
+
10
+ - Analyze resumes and extract key information.
11
+ - Search for job listings based on user input.
12
+ - Match job listings with resumes and provide detailed insights.
13
+ - Visualize the job search architecture.
14
+
15
+ ## Requirements
16
+
17
+ - Docker
18
+ - Docker Compose
19
+
20
+ ## Getting Started
21
+
22
+ ### Clone the Repository
23
+
24
+ ```bash
25
+ git clone https://github.com/YOUR_GITHUB_USERNAME/AI-Job-Search.git
26
+ cd AI-Job-Search
27
+ ```
28
+
29
+ ### Build the Docker Image
30
+
31
+ ```bash
32
+ docker build -t ai-job-search .
33
+ ```
34
+
35
+ ### Run the Docker Container
36
+
37
+ ```bash
38
+ docker run -p 8504:8504 ai-job-search
39
+ ```
40
+
41
+ ### Access the Application
42
+
43
+ Open your web browser and go to [http://localhost:8504](http://localhost:8504).
44
+
45
+ ---
46
+
47
+ ## Project Structure
48
+
49
+ ```
50
+ .
51
+ β”œβ”€β”€ Dockerfile # Docker configuration file
52
+ β”œβ”€β”€ README.md # Project documentation
53
+ β”œβ”€β”€ requirements.txt # Python dependencies
54
+ β”œβ”€β”€ main.py # Main application code
55
+ β”œβ”€β”€ flowchart.py # Code for generating the job search architecture diagram
56
+ └── ... # Additional files as needed
57
+ ```
58
+
59
  ---
60
+
61
+ ## Usage
62
+
63
+ 1. **Enter Job Search Description**: Provide a description of the job you are looking for.
64
+ 2. **Upload Resume**: Upload or paste your complete resume for AI analysis.
65
+ 3. **Enter Groq API Key**: Provide your Groq API key for AI-powered job search and matching.
66
+ 4. **Start Advanced Search**: Click the button to initiate the job search and receive insights.
67
+
68
+ ---
69
+
70
+ ## Contact
71
+
72
+ For any questions or inquiries, please contact me on [LinkedIn](https://www.linkedin.com/in/nihar-palem-1b955a183/).
73
+
74
  ---
75