updated installation instructions and make file

espin086 · Sep 16, 2024 · f90e686 · f90e686
1 parent 89c25d3
commit f90e686
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 34 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -9,19 +9,14 @@ Before proceeding with the installation, please make sure you have the following
 - Access to a Linux terminal (Mac or Ubuntu) or a WSL on Windows
 - Subscription to Rapidapi and the Linkedin Job search service: [Rapidapi](https://rapidapi.com/jaypat87/api/linkedin-jobs-search)
 
-## Step 0: Clone the repository and create a virtual environment.
+## Step 0: Clone the repository and create a virtual environment and install the software.
 
 Clone the repository to your local environment and create the virtual environment.
 
 ```bash
-cd jobhunter
-make virtualenv
-```
-
-Once the virtual environment is created, activate it using the following command:
-
-```bash
-source jobhunter-venv/bin/activate
+conda create --name jobhunter python=3.10
+conda activate jobhunter
+pip install -r requirements.txt
 ```
 
 ## Step 1: Copy the .env-template
@@ -39,29 +34,10 @@ Next, open the `.env` file in a text editor and add your Rapid API Key. This key
 ### Add OpenAI API KEY (Optional)
 You can also add OpenAI API key to the `.env` file to get GPT based resume similarity score. This is optional feature, and currently in development, and will be available in full version soon. You can sign up for OpenAI API [here](https://platform.openai.com/apps)
 
-## Step 3: Update the job titles and locations
-
-Update the job titles and locations you'd like to search for by opening up the `config.py` file located here:
-
-```shell
-jobhunter/jobhunter/config.py
-```
-
-Update the lists below:
-
-![Alt](images/image_job_config.png)
-
-## Step 4: Upload your resume in .txt format
-
-You will need to add your resume as `resume.txt` to the following location:
-
-```
-jobhunter/temp/resumes/resume.txt
-```
 
-## Step 5: Test the program
+## Step 5: Set up Dependencies and Test the Installation
 
-To ensure that everything is set up correctly, run the following command to run the tests:
+To ensure that everything is set up correctly, run the following command to run the install all dependencies and run unit tests on the jobhunter:
 
 ```shell
 make check

diff --git a/Makefile b/Makefile
@@ -3,14 +3,15 @@ SRC_DIR:=$(ROOT_DIR)/jobhunter
 
 virtualenv:
 	cp .env-template .env
-	python3 -m venv jobhunter-venv
-	echo "RUN THIS!!!: source jobhunter-venv/bin/activate"
+	conda create --name jobhunter python=3.11
+	conda activate jobhunter
 
 .PHONY: install test lint format
 
 install:
-	python -m pip install --upgrade pip
-	python3 -m pip install -e .
+	conda create --name jobhunter python=3.10
+	conda activate jobhunter
+	pip install -r requirements.txt
 
 format:
 	python3 -m black $(SRC_DIR)