Job Advertisement Generator README

Welcome to the Tech Job Advertisement Generator! This tool is designed to assist HR professionals in creating effective relevant technical job advertisements quickly and efficiently.

Table of Contents

1. Introduction
2. Features
3. Requirements
4. Installation
5. Usage
6. Contributing
7. License

Introduction

The Job Advertisement Generator (JAG) is a tool developed to simplify the process of drafting job advertisements. It automates the generation of job descriptions based on user input, saving time and ensuring consistency in job postings.

Features

• Customizable Templates: JAG provides customizable templates for various job roles, allowing users to tailor job descriptions to their specific needs.
• Keyword Suggestions: The tool suggests relevant keywords based on the job title and description, optimizing the advertisement for search engines and candidate matching.
• Preview Functionality: Users can preview the generated job advertisement before finalizing and publishing it.
• Export Options: JAG supports exporting job advertisements in multiple formats (e.g., PDF, plain text) for easy sharing and distribution.

Requirements

To use JAG, you’ll need:

• Python 3.x
• Dependencies listed in requirements.txt

Installation

1. Clone the repository: git clone https://github.com/Swan-Z/JobAdGenerator.git
2. Download Conda and activate it
3. Install dependencies: pip install -r requirements.txt
4. Introduce an OpenAI API key in demo/llamaService.py

Usage

1. Run the backend: HackUPC2024/ python main.py
2. Run the frontend: Hackaton2024-front/ ionic serve
3. Follow the on-screen prompts to input job details and preferences.
4. Preview the generated job advertisement.
   
   

Contributing

We welcome contributions from the community! If you’d like to contribute to the development of JAG, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature: git checkout -b feature-name
3. Make your changes and commit them: git commit -m 'Add new feature'
4. Push to the branch: git push origin feature-name
5. Submit a pull request.

License

This project is licensed under the MIT License - see the https://github.com/Swan-Z/JobAdGenerator2/blob/main/LICENSE file for details.