You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
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.
Notifications You must be signed in to change notification settings
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Go to fileFollow these steps to set up the environment and run the application.
git clone https://github.com/YOUR-USERNAME>/Resume-Matcher.git cd Resume-Matcher
virtualenv env
OR
python -m venv env
env\Scripts\activate
source env/bin/activate
OPTIONAL (For pyenv users)
Run the application with pyenv (Refer this article)
sudo apt-get install -y make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev liblzma-dev python openssl
sudo apt-get install build-essential zlib1g-dev libffi-dev libssl-dev libbz2-dev libreadline-dev libsqlite3-dev liblzma-dev libncurses-dev sudo apt-get install python-tk python3-tk tk-dev sudo apt-get install build-essential zlib1g-dev libffi-dev libssl-dev libbz2-dev libreadline-dev libsqlite3-dev liblzma-dev
curl https://pyenv.run | bash
pyenv install -v 3.11.0
pyenv virtualenv 3.11.0 venv
pyenv activate venv
pip install -r requirements.txt
python run_first.py
streamlit run streamlit_app.py
Note: For local versions, you do not need to run "streamlit_second.py" as it is specifically for deploying to Streamlit servers.
Additional Note: The Vector Similarity part is precomputed to optimize performance due to the resource-intensive nature of sentence encoders that require significant GPU and RAM resources. If you are interested in leveraging this feature in a Google Colab environment for free, refer to the upcoming blog (link to be provided) for further guidance.
docker-compose up
The full stack Next.js (React and FastAPI) web application allows users to interact with the Resume Matcher tool interactively via a web browser.
The results returned from through the web app are currently entirely mocked / faked. This means that the results returned are not real and are just for demonstration purposes. This will be implemented with real data results in a future release.
To run the full stack web application (frontend client and backend api servers), follow the instructions over on the webapp README file.
This project uses Black for code formatting. We believe this helps to keep the code base consistent and reduces the cognitive load when reading code.
Before submitting your pull request, please make sure your changes are in accordance with the Black style guide. You can format your code by running the following command in your terminal:
black .
We also use pre-commit to automatically check for common issues before commits are submitted. This includes checks for code formatting with Black.
If you haven't already, please install the pre-commit hooks by running the following command in your terminal:
pip install pre-commit pre-commit install
Now, the pre-commit hooks will automatically run every time you commit your changes. If any of the hooks fail, the commit will be aborted.
Pull Requests & Issues are not just welcomed, they're celebrated! Let's create together.
🎉 Join our lively Discord community and discuss away!
💡 Spot a problem? Create an issue!
👩💻 Dive in and help resolve existing issues.
🚀 Explore and improve our Landing Page. PRs always welcome!
📚 Contribute to the Resume Matcher Docs and help people get started with using the software.
Your support means the world to us 💙. We're nurturing this project with an open-source community spirit, and we have an ambitious roadmap ahead! Here are some ways you could contribute and make a significant impact:
✨ Transform our Streamlit dashboard into something more robust.
💡 Improve our parsing algorithm, making data more accessible.
🖋 Share your insights and experiences in a blog post to help others.
Take the leap, contribute, and let's grow together! 🚀