chore: import upstream snapshot with attribution

2026-07-13 12:39:36 +08:00
commit 5bdf4cc89a
423 changed files with 88197 additions and 0 deletions
@@ -0,0 +1,132 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[srbh077@gmail.com](mailto:srbh077@gmail.com).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
@@ -0,0 +1,207 @@
+# Contributing to Resume-Matcher on GitHub
+
+Thank you for taking the time to contribute to [Resume-Matcher](https://github.com/srbhr/Resume-Matcher).
+
+We want you to have a great experience making your first contribution.
+
+This contribution could be anything from a small fix to a typo in our
+documentation or a full feature.
+
+Tell us what you enjoy working on and we would love to help!
+
+If you would like to contribute, but don't know where to start, check the
+issues that are labeled
+`good first issue`
+or
+`help wanted`.
+
+Contributions make the open-source community a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.
+
+The development branch is `main`. This is the branch where all pull requests should be made.
+
+## Reporting Bugs
+
+Please try to create bug reports that are:
+
+- Reproducible. Include steps to reproduce the problem.
+- Specific. Include as much detail as possible: which version, what environment, etc.
+- Unique. Do not duplicate existing opened issues.
+- Scoped to a Single Bug. One bug per report.
+
+## Testing
+
+Please test your changes before submitting the PR.
+
+## Good First Issues
+
+We have a list of `help wanted` and `good first issue` that contains small features and bugs with a relatively limited scope. Nevertheless, this is a great place to get started, gain experience, and get familiar with our contribution process.
+
+## Development
+
+Follow these steps to set up the environment and run the application.
+
+## How to install
+
+1. Fork the repository [here](https://github.com/srbhr/Resume-Matcher/fork).
+
+2. Clone the forked repository.
+
+   ```bash
+   git clone https://github.com/<YOUR-USERNAME>/Resume-Matcher.git
+   cd Resume-Matcher
+   ```
+
+3. Create a Python Virtual Environment:
+
+   - Using [virtualenv](https://learnpython.com/blog/how-to-use-virtualenv-python/):
+
+     _Note_: Check how to install virtualenv on your system here [link](https://learnpython.com/blog/how-to-use-virtualenv-python/).
+
+     ```bash
+     virtualenv env
+     ```
+
+   **OR**
+
+   - Create a Python Virtual Environment:
+
+     ```bash
+     python -m venv env
+     ```
+
+4. Activate the Virtual Environment.
+
+   - On Windows.
+
+     ```bash
+     env\Scripts\activate
+     ```
+
+   - On macOS and Linux.
+
+     ```bash
+     source env/bin/activate
+     ```
+
+    **OPTIONAL (For pyenv users)**
+
+   Run the application with pyenv (Refer to this [article](https://realpython.com/intro-to-pyenv/#installing-pyenv))
+
+   - Build dependencies (on ubuntu)
+      ```
+      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
+
+      ```
+
+        - pyenv installer
+     ```
+        curl https://pyenv.run | bash
+     ```
+   - Install desired python version
+     ```
+       pyenv install -v 3.11.0
+     ```
+
+   - pyenv with virtual enviroment
+     ```
+        pyenv virtualenv 3.11.0 venv
+     ```
+
+   - Activate virtualenv with pyenv
+     ```
+        pyenv activate venv
+     ```
+
+     5. Install Dependencies:
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+6. Prepare Data:
+
+   - Resumes: Place your resumes in PDF format in the `Data/Resumes` folder. Remove any existing contents in this folder.
+   - Job Descriptions: Place your job descriptions in PDF format in the `Data/JobDescription` folder. Remove any existing contents in this folder.
+
+7. Parse Resumes to JSON:
+
+   ```python
+   python run_first.py
+   ```
+
+8. Run the Application:
+
+   ```python
+   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.
+
+<br/>
+
+### Docker
+
+1. Build the image and start application
+
+   ```bash
+       docker-compose up
+   ```
+
+2. Open `localhost:80` on your browser
+
+<br/>
+
+### Running the Web Application
+
+The full stack Next.js (React and FastAPI) web application allows users to interact with the Resume Matcher tool interactively via a web browser.
+
+To run the full stack web application (frontend client and backend api servers), follow the instructions over on the [webapp README](/webapp/README.md) file.
+
+## Code Formatting
+
+This project uses [Black](https://black.readthedocs.io/en/stable/) 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:
+
+```sh
+black .
+```
+
+## Pre-commit Hooks
+
+We also use [pre-commit](https://pre-commit.com/) 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:
+
+```sh
+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.
+
+## Join Us, Contribute!
+
+Pull Requests & Issues are not just welcomed, they're celebrated! Let's create together.
+
+🎉 Join our lively [Discord](https://dsc.gg/resume-matcher) community and discuss away!
+
+💡 Spot a problem? Create an issue!
+
+👩‍💻 Dive in and help resolve existing [issues](https://github.com/srbhr/Resume-Matcher/issues).
+
+🔔 Share your thoughts in our [Discussions & Announcements](https://github.com/srbhr/Resume-Matcher/discussions).
+
+🚀 Explore and improve our [Landing Page](https://github.com/srbhr/website-for-resume-matcher). PRs always welcome!
+
+📚 Contribute to the [Resume Matcher Docs](https://github.com/srbhr/Resume-Matcher-Docs) and help people get started with using the software.
@@ -0,0 +1,2 @@
+github: srbhr
+custom: ["https://github.com/sponsors/srbhr"]
@@ -0,0 +1,42 @@
+# Issue Title
+<!-- Provide a concise and descriptive title for the issue -->
+
+## Type
+<!-- Check the relevant options by putting an "x" in the brackets -->
+
+- [ ] Big
+- [ ] Feature Request
+- [ ] Info
+- [ ] Bug
+- [ ] Documentation
+- [ ] Other (please specify):
+
+## Description
+<!-- Describe the issue in detail. What problem are you experiencing or what feature would you like to see added? -->
+
+## Expected Behavior
+<!-- Describe what you expected to happen when encountering the issue -->
+
+## Current Behavior
+<!-- Describe what is currently happening due to the issue -->
+
+## Steps to Reproduce
+<!-- If applicable, provide a step-by-step guide to reproducing the issue -->
+1.
+2.
+3.
+
+## Screenshots / Code Snippets (if applicable)
+<!-- Include any relevant screenshots or code snippets that can help understand the issue better -->
+
+## Environment
+<!-- Provide details about your environment -->
+- Operating System:
+- Browser (if applicable):
+- Version/Commit ID (if applicable):
+
+## Possible Solution (if you have any in mind)
+<!-- If you have an idea about how to fix the issue, please share it here -->
+
+## Additional Information
+<!-- Add any other information about the issue that you think might be helpful -->
@@ -0,0 +1,59 @@
+name: Bug Report
+description: Create a report to help us improve
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+      placeholder: When I click the button, nothing happens...
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: Please provide details about your OS, Browser version, or Device.
+      value: |
+        - OS: [e.g. macOS / Windows / iOS]
+        - Browser / Version: [e.g. Chrome 100]
+        - Device: [e.g. iPhone 14]
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+    validations:
+      required: false
@@ -0,0 +1,15 @@
+# This prevents users from clicking "Open new issue" without picking a template first.
+blank_issues_enabled: false
+
+contact_links:
+  - name: 💬 Ask a Question (Discussions)
+    url: https://github.com/srbhr/Resume-Matcher/discussions
+    about: Please ask usage questions or discuss ideas here before opening a formal issue.
+
+  - name: 🔐 Report a Security Vulnerability
+    url: https://github.com/srbhr/Resume-Matcher/security/advisories/new
+    about: Please do not open public issues for security vulnerabilities.
+
+  - name: 📖 Read the Documentation
+    url: https://github.com/srbhr/Resume-Matcher/blob/master/README.md
+    about: Check the docs to see if your answer is already there.
@@ -0,0 +1,12 @@
+name: Custom / Other
+description: Describe this issue template's purpose here.
+title: ""
+labels: []
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Please describe your issue.
+    validations:
+      required: true
@@ -0,0 +1,42 @@
+name: Feature Request
+description: Suggest an idea for this project
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to suggest a new feature!
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+      placeholder: I am frustrated when...
+    validations:
+      required: false
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
@@ -0,0 +1,50 @@
+# Pull Request Title
+<!-- Provide a concise and descriptive title for the pull request -->
+
+## Related Issue
+<!-- If this pull request is related to an issue, please link it here using the "#" symbol followed by the issue number (e.g., #123) -->
+
+## Description
+<!-- Describe the changes made in this pull request. What problem does it solve or what feature does it add/modify? -->
+copilot:summary
+
+## Type
+<!-- Check the relevant options by putting an "x" in the brackets -->
+
+- [ ] Bug Fix
+- [ ] Feature Enhancement
+- [ ] Documentation Update
+- [ ] Code Refactoring
+- [ ] Other (please specify):
+
+## Proposed Changes
+<!-- List the specific changes made in this pull request -->
+
+-
+-
+-
+
+## Screenshots / Code Snippets (if applicable)
+<!-- Include any relevant screenshots or code snippets that help visualize the changes made -->
+
+## How to Test
+<!-- Provide step-by-step instructions or a checklist for testing the changes in this pull request -->
+
+1.
+2.
+3.
+
+## Checklist
+<!-- Put an "x" in the brackets for the items that apply to this pull request -->
+
+- [ ] The code compiles successfully without any errors or warnings
+- [ ] The changes have been tested and verified
+- [ ] The documentation has been updated (if applicable)
+- [ ] The changes follow the project's coding guidelines and best practices
+- [ ] The commit messages are descriptive and follow the project's guidelines
+- [ ] All tests (if applicable) pass successfully
+- [ ] This pull request has been linked to the related issue (if applicable)
+
+## Additional Information
+<!-- Add any other information about the pull request that you think might be helpful -->
+copilot:walkthrough
@@ -0,0 +1,9 @@
+# Responsible Disclosure
+
+## Reporting a Vulnerability
+
+Resume-Matcher strives to stay ahead of security vulnerabilities but would love to get the community's help in making us aware of the ones we miss.
+
+Please contact a maintainer to report security vulnerabilities and exploits.
+
+We will acknowledge legitimate reports and address them according to their severity.
@@ -0,0 +1,66 @@
+name: Publish Docker Image
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*.*.*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    env:
+      HAS_DOCKERHUB: ${{ secrets.DOCKERHUB_USERNAME }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Login to Docker Hub
+        if: ${{ env.HAS_DOCKERHUB != '' }}
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Extract image metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ghcr.io/srbhr/resume-matcher
+            ${{ env.HAS_DOCKERHUB != '' && 'srbhr/resume-matcher' || '' }}
+          tags: |
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=semver,pattern={{version}},value=${{ github.ref_name }},enable=${{ startsWith(github.ref, 'refs/tags/v') }}
+            type=semver,pattern={{major}}.{{minor}},value=${{ github.ref_name }},enable=${{ startsWith(github.ref, 'refs/tags/v') }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: Dockerfile
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max