Note: The Blog is outdated with respect to the User Interface and Template used.
| Requirement | Link |
|---|---|
| Docker | Get Docker |
| Docker Compose | Install Compose |
🔽 Click to expand setup instructions
git clone https://github.com/aadya940/autoresume.git
cd autoresumedocker compose up --build| 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! |
This project is licensed under the Apache 2.0 License.
✦ 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
✦ 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
✦ Branch Management
git checkout -b your-branch-name
✦ Write clear commit messages ✦ Test your changes before submitting a PR
Pull Request Checklist
✦ What changes you made
✦ Why you made them
✦ Any relevant screenshots or test results
✦ Any breaking changes or migration steps needed
Built with ❤️ by the autoResume community