The OpenAI Resume Builder is a web application that generates resumes based on user-provided information. Users can input their name, education, skills, and hobbies, and the app uses the OpenAI API to create a one-page resume tailored for a software engineering job.
- User-friendly interface for inputting personal and professional details.
- Integration with the OpenAI API for generating personalized resumes.
- Ability to add and manage education, skills, and hobbies.
- Outputs a one-page resume highlighting skills for a software engineering job.
To get started with the OpenAI Resume Builder, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/AmirhosseinOlyaei/Resume-Builder-React-OpenAI.git
-
Install the required dependencies:
npm install
-
Obtain an OpenAI API key. You can sign up for an API key from the OpenAI website.
-
Create a
.env
file in the root directory of your project and store your API key as follows:REACT_APP_OPENAI_API_KEY=your-api-key
-
Start the development server:
npm run dev
-
Access the application in your web browser at
http://localhost:3000
or another port number allocated by your system.
-
Enter your OpenAI API key in the provided input field and click "Submit API Key."
-
Fill out your name, education, skills, and hobbies in the respective input fields.
-
Click the "Generate Resume" button to create a one-page resume highlighting your skills for a software engineering job.
-
The generated resume will be displayed with line breaks using
<br/>
tags.
- React
- Vite
- OpenAI API
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Contributions are welcome! If you'd like to contribute to the project, please follow our contribution guidelines.
This project is licensed under the MIT License - see the LICENSE file for details.
-
This app is powered by the OpenAI API. Visit OpenAI for more information.
-
Special thanks and a shout out to the following individuals and organizations:
If you have any questions or feedback, feel free to reach out to Amir.
Happy Resume Building!