Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wodenwang820118/streamlit-resume-matcher
A sample Streamlit app with Angular
https://github.com/wodenwang820118/streamlit-resume-matcher
angular17 streamlit
Last synced: 6 days ago
JSON representation
A sample Streamlit app with Angular
- Host: GitHub
- URL: https://github.com/wodenwang820118/streamlit-resume-matcher
- Owner: WodenWang820118
- License: mit
- Created: 2024-04-23T04:45:50.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-25T13:04:19.000Z (7 months ago)
- Last Synced: 2024-04-25T16:11:12.660Z (7 months ago)
- Topics: angular17, streamlit
- Language: TypeScript
- Homepage: https://cosine-resume.streamlit.app/
- Size: 652 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Streamlit Resume Matcher
[](https://cosine-resume.streamlit.app/)
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Architecture](#architecture)
- [Deployment](#deployment)
- [License](#license)
## Introduction
A simple resume matcher app built using Streamlit and Angular. The app calculates the match percentage between a job description and a resume using cosine similarity.
After opening the app, press F12 to force the Angular app to load via an iframe. Let me know how to fix this issue.
## Features
- Upload a job description and a resume
- Calculate the match percentage based on cosine similarity
- Display the results using Streamlit components
## Installation
1. Clone the repository:
```bash
git clone https://github.com/WodenWang820118/streamlit-resume-matcher.git
```
2. Install the required dependencies:
```bash
pip install -r requirements.txt
```
3. Please add a `.env` file in the root directory with the following content:
```bash
ENVIRONMENT=development
```
4. Run the Streamlit app:
```bash
streamlit run lib/main.py
```
or
```bash
python -m streamlit run lib/main.py
```
## Architecture
Personally, I don't like to count on Streamlit components for the frontend, so instead of building a custom component, I decided to embed an Angular app inside the Streamlit app. Angular is responsible for all the business logic and Streamlit handles the coming data and calculates the cosine similarity. Finally, the app uses the Streamlit components to display the results.
Please note there is an experimental feature called [st.experimental_fragment](https://docs.streamlit.io/develop/quick-reference/changelog), which might reinforce the data binding between the Angular app and the Streamlit app. The ideal scenario would be to use this feature to pass the data between the two apps. Use Angular to handle the business logic and UI. Let Streamlit only handle the Python code.
## Deployment
I'm using Netlify to deploy the app, so for production usage, you'll need to deploy the frontend somewhere. Please see the `lib/root_component/__init__.py` for details.
## License
This project is licensed under the [MIT License](https://github.com/WodenWang820118/streamlit-resume-matcher/blob/main/LICENSE).