autoResume

✨ Open‑source resume builder, paste your links, edit manually, and let AI lend a hand with polishing, updating, and tailoring your resume. ✨

---

How to use this?

📖 Medium Blog Link

Note: The Blog is outdated with respect to the User Interface and Template used.

---

Features

---

Getting Started

Prerequisites

Requirement	Link
Docker	Get Docker
Docker Compose	Install Compose

Setup

🔽 Click to expand setup instructions

Step 1: Clone the repository

git clone https://github.com/aadya940/autoresume.git
cd autoresume

Step 2: Build and start the app

docker compose up --build

Step 3: Access the apps

http://localhost:5173

---

Usage

Step	Action	Description
1️⃣	Open Browser	Open autoResume in your browser
2️⃣	Setup API	Click on the ⚙️ icon, paste in your GOOGLE API KEY and your Email
3️⃣	Add Links	Paste links to your professional information (e.g., Github, Personal Website, etc.)
4️⃣	Customize	Optionally, add feedback or a job posting link for further customization
5️⃣	Generate	Click Generate Resume and let the AI do the rest!

---

License

 This project is licensed under the Apache 2.0 License.

---

Contributing Guide

Frontend

✦ Implement React components in the frontend/src/components/ folder

✦ We use Chakra UI to implement components

✦ Import and use your components in frontend/src/App.jsx

Backend

✦ Implement API routes in the backend/src/routes/ directory

✦ Add AI functionality in the backend/src/ai/ directory

✦ We use the black code formatter for Python code

✦ Keep route handlers clean and logic separate

General Guidelines

✦ Branch Management bash git checkout -b your-branch-name

✦ Write clear commit messages ✦ Test your changes before submitting a PR

Submitting Changes

Pull Request Checklist

1. Create a Pull Request

2. In your PR description, include:

✦ What changes you made

✦ Why you made them

✦ Any relevant screenshots or test results

✦ Any breaking changes or migration steps needed

---

We appreciate your contributions and will review your PR as soon as possible!

---

_{Built with ❤️ by the autoResume community}