Warning

This is still a beta, expect issues, security or otherwise, if you find so, please report them!

Waltzes

Waltzes is a project designed to generate personalized cover letters based on job details and resume information. It consists of a browser extension and a Flask server.

Table of Contents

• Installation
• Usage
• Extension Setup
• Flask Server Setup
• Contributing
• License

Installation

Prerequisites

• Python 3.8+
• Flask
• Browser (Chrome or Firefox)

Usage

Extension Setup

1. Clone the repository:

   git clone https://github.com/UmairJibran/waltzes.git
   cd waltzes/addon

2. Load the extension in your browser:

   • Chrome:
     1. Open Chrome and navigate to chrome://extensions/.
     2. Enable "Developer mode" by clicking the toggle switch in the top right corner.
     3. Click "Load unpacked" and select the addon directory.
   • Firefox:
     1. Open Firefox and navigate to about:debugging#/runtime/this-firefox.
     2. Click "Load Temporary Add-on" and select any file in the addon directory.

3. Configure the extension:

   • Copy the extension ID (e.g., 6546988c-c591-4bce-8e38-357819650252).
   • Go to the following url moz-extension://{YOUR_TEMPORARY_EXTENSION_ID}/src/configure.html
   • Provide your OpenAI API key and the Flask server URL.
   • Click "Save".

Flask Server Setup

1. Navigate to the python directory:

   cd ../python

2. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install dependencies:

   pip install -r requirements.txt

4. Create a .env file in the python directory and add your OpenAI API key:

   OPENAI_API_KEY=your_openai_api_key

5. Run the Flask server:

   flask run

Contributing

Contributions are welcome! Please read the contributing guidelines first.

License

This project is licensed under the MIT License. See the LICENSE file for details.