๐ Live Demo
Welcome to the GPT_CurriculumParser project! This Flask-based website provides information about Curriculums turned into a JSON object. Below are step-by-step instructions to set up and run this project.
- Prerequisites
- Cloning the Project
- Setting Up OpenAI Key
- Installing Dependencies
- Running the Flask Application
Before you begin, ensure you have the following installed on your system:
- Python (Version 3.8 or above)
- Git
- Open a terminal or command prompt.
- Navigate to the directory where you want to clone the project.
- Run the following command:
git clone https://github.com/hitthecodelabs/GPT_CurriculumParser.git
- Locate the app.py file in the project's root directory.
- Open app.py in your preferred text editor.
- Find the variable named OPENAI_SECRET_KEY and replace 'YOUR_OPENAI_KEY_HERE' with your actual OpenAI API key:
import openai
openai.api_key = 'YOUR_OPENAI_KEY_HERE'
- In the same app.py file, fill the prompt variable. Based on the context you provided, this will likely be a string that instructs OpenAI on what kind of response you are looking for. For example:
prompt = (f"Collect the following resume to extract structured information... ")
- Navigate to the project's root directory in the terminal.
cd GPT_CurriculumParser
- Create a virtual environment (recommended for isolated Python environments):
python -m venv venv
- Activate the virtual environment:
- On Windows:
.\venv\Scripts\activate
- On macOS and Linux:
source venv/bin/activate
- Install the required libraries:
pip install -r requirements.txt
- While inside the project's root directory and with the virtual environment activated, run the following command:
python app.py
- You should see a message indicating that the server has started, usually with a URL like http://127.0.0.1:5000/.
- Open the provided URL in your web browser to view and interact with the Flask application!
That's it! You've successfully set up and run the HitTheCodeLabs Website project locally. Don't forget to check out the live demo! Enjoy exploring and customizing further!