srbhr / Resume-Matcher

Resume Matcher is an open source, free tool to improve your resume. It works by using language models to compare and rank resumes with job descriptions.
https://www.resumematcher.fyi/
Apache License 2.0
4.84k stars 2.04k forks source link

Need proper installation instructions. [Create a blog/technical article] #64

Closed farkas1companion closed 1 year ago

farkas1companion commented 1 year ago

Are there any proper installation instructions? I need help getting this project working. After git clone https://github.com/srbhr/website-for-resume-matcher.git now what to do?

srbhr commented 1 year ago

Hi @farkas1companion I will be creating a detailed guide on how to install this.

Answering your question:

  1. git clone https://github.com/srbhr/website-for-resume-matcher.git
  2. pip install -r requirements.txt
  3. Put your resumes in PDF Format in the Data/Resumes folder. (Delete the existing contents)
  4. Put your Job Descriptions in PDF Format in Data/JobDescription folder. (Delete the existing contents)
  5. Run python run_first.py this will parse all the resumes to JSON.
  6. Run streamlit run streamlit_app.py.

Happy to help 😁

farkas1companion commented 1 year ago

Okay

srbhr commented 1 year ago

Yes, re-opening as there's a blog to be made.

TODO: Create a detailed blog helping people understand how to install Resume-Matcher.

And add the link to the README.md

gyanu-kharel commented 1 year ago

Hi @farkas1companion I will be creating a detailed guide on how to install this.

Answering your question:

  1. git clone https://github.com/srbhr/website-for-resume-matcher.git
  2. pip install -r requirements.txt
  3. Put your resumes in PDF Format in the Data/Resumes folder. (Delete the existing contents)
  4. Put your Job Descriptions in PDF Format in Data/JobDescription folder. (Delete the existing contents)
  5. Run python run_first.py this will parse all the resumes to JSON.
  6. Run streamlit run streamlit_app.py.

Happy to help 😁

You mean git clone https://github.com/srbhr/Resume-Matcher.git ?

srbhr commented 1 year ago

@gyanu-kharel yeah 😅😅 that's the landing page.

srbhr commented 1 year ago

@farkas1companion please check: https://github.com/srbhr/Resume-Matcher-Docs