Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add script for automating project setup #317

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Pterjudin
Copy link

Pull Request Title

Add Automated Setup Script and Documentation for Resume Matcher

Related Issue

N/A

Description

This pull request adds an automated setup script (setup.sh) that streamlines the installation and setup process for the Resume Matcher project. Additionally, it includes a new README.md file explaining how to use the script.

Type

  • Feature Enhancement
  • Documentation Update
  • Bug Fix
  • Code Refactoring
  • Other (please specify):

Proposed Changes

  • Added setup.sh to automate installation, virtual environment setup, and dependency management
  • Created a README.md file with detailed setup instructions
  • Ensured Streamlit is installed and launched after setup completion
  • Implemented error handling for common installation issues (e.g., missing dependencies, virtual environment activation)

Screenshots / Code Snippets (if applicable)

N/A

How to Test

  1. Clone the repository:
    git clone https://github.com/YOUR-USERNAME/Resume-Matcher.git
    cd Resume-Matcher

execute

bash scripts/utils/project-setup/setup.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant