@@ -57,65 +57,65 @@ Follow these steps to set up the environment and run the application.
57
57
58
58
2 . Clone the forked repository.
59
59
60
- ``` bash
61
- git clone https://github.com/< YOUR-USERNAME> /Resume-Matcher.git
62
- cd Resume-Matcher
63
- ```
60
+ ``` bash
61
+ git clone https://github.com/< YOUR-USERNAME> /Resume-Matcher.git
62
+ cd Resume-Matcher
63
+ ```
64
64
65
65
3 . Create a Python Virtual Environment:
66
66
67
- - Using [virtualenv](https://learnpython.com/blog/how-to-use-virtualenv-python/):
67
+ - Using [ virtualenv] ( https://learnpython.com/blog/how-to-use-virtualenv-python/ ) :
68
68
69
- _Note_: Check how to install virtualenv on your system here [link](https://learnpython.com/blog/how-to-use-virtualenv-python/).
69
+ _ Note_ : Check how to install virtualenv on your system here [ link] ( https://learnpython.com/blog/how-to-use-virtualenv-python/ ) .
70
70
71
- ` ` ` bash
72
- virtualenv env
73
- ` ` `
71
+ ``` bash
72
+ virtualenv env
73
+ ```
74
74
75
- ** OR**
75
+ ** OR**
76
76
77
- - Create a Python Virtual Environment:
77
+ - Create a Python Virtual Environment:
78
78
79
- ` ` ` bash
80
- python -m venv env
81
- ` ` `
79
+ ` ` ` bash
80
+ python -m venv env
81
+ ` ` `
82
82
83
83
4. Activate the Virtual Environment.
84
84
85
- - On Windows.
85
+ - On Windows.
86
86
87
- ` ` ` bash
88
- env\S cripts\a ctivate
89
- ` ` `
87
+ ` ` ` bash
88
+ env\S cripts\a ctivate
89
+ ` ` `
90
90
91
- - On macOS and Linux.
91
+ - On macOS and Linux.
92
92
93
- ` ` ` bash
94
- source env/bin/activate
95
- ` ` `
93
+ ` ` ` bash
94
+ source env/bin/activate
95
+ ` ` `
96
96
97
97
5. Install Dependencies:
98
98
99
- ` ` ` bash
100
- pip install -r requirements.txt
101
- ` ` `
99
+ ` ` ` bash
100
+ pip install -r requirements.txt
101
+ ` ` `
102
102
103
103
6. Prepare Data:
104
104
105
- - Resumes: Place your resumes in PDF format in the ` Data/Resumes` folder. Remove any existing contents in this folder.
106
- - Job Descriptions: Place your job descriptions in PDF format in the ` Data/JobDescription` folder. Remove any existing contents in this folder.
105
+ - Resumes: Place your resumes in PDF format in the ` Data/Resumes` folder. Remove any existing contents in this folder.
106
+ - Job Descriptions: Place your job descriptions in PDF format in the ` Data/JobDescription` folder. Remove any existing contents in this folder.
107
107
108
108
7. Parse Resumes to JSON:
109
109
110
- ` ` ` python
111
- python run_first.py
112
- ` ` `
110
+ ` ` ` python
111
+ python run_first.py
112
+ ` ` `
113
113
114
114
8. Run the Application:
115
115
116
- ` ` ` python
117
- streamlit run streamlit_app.py
118
- ` ` `
116
+ ` ` ` python
117
+ streamlit run streamlit_app.py
118
+ ` ` `
119
119
120
120
** Note** : For local versions, you do not need to run " streamlit_second.py" as it is specifically for deploying to Streamlit servers.
121
121
@@ -127,12 +127,29 @@ Follow these steps to set up the environment and run the application.
127
127
128
128
1. Build the image and start application
129
129
130
- ` ` ` bash
131
- docker-compose up
132
- ` ` `
130
+ ` ` ` bash
131
+ docker-compose up
132
+ ` ` `
133
133
134
134
2. Open ` localhost:80` on your browser
135
135
136
+ # ## Cohere and Qdrant
137
+
138
+ 1. Visit [Cohere website registration](https://dashboard.cohere.ai/welcome/register) and create an account.
139
+ 2. Go to API keys and copy your cohere api key.
140
+ 3. Visit [Qdrant website](https://cloud.qdrant.io/) and create an account.
141
+ 4. Get your api key and cluster url as well
142
+ 5. Now create a yaml file named config.yml in Scripts/Similarity/ folder.
143
+ 6. The format for the conifg file should be as below:
144
+ ` ` ` yaml
145
+ cohere:
146
+ api_key: cohere_key
147
+ qdrant:
148
+ api_key: qdrant_api_key
149
+ url: qdrant_cluster_url
150
+ ` ` `
151
+ 7. Please replace your values without any quotes.
152
+
136
153
< br/>
137
154
138
155
< div align=" center" >
0 commit comments