README.md

---
title: Resumebuilder
emoji: 🚀
colorFrom: yellow
colorTo: indigo
sdk: docker
pinned: false
license: mit
short_description: An AI resume builder
---

# Resume Builder

An AI-powered resume builder application that allows users to create professional resumes with multiple format exports.

## Features

- User authentication with email/password and GitHub OAuth
- AI-powered profile summary generation using OpenAI
- Multiple resume sections: Introduction, Work Experience, Projects, Education, Skills, Achievements
- Export resumes in Word (.docx) and PDF formats
- Admin panel for user management
- Responsive design with Bootstrap

## Hugging Face Deployment

This app is configured to run on Hugging Face Spaces with Docker.

### Required Environment Variables

Set these in your Space settings:

- `SECRET_KEY` - Flask secret key
- `DATABASE_URL` - PostgreSQL connection string (using Neon)
- `SQLALCHEMY_DATABASE_URI` - Same as DATABASE_URL
- `GITHUB_CLIENT_ID` - GitHub OAuth client ID
- `GITHUB_CLIENT_SECRET` - GitHub OAuth client secret
- `GITHUB_OAUTH_BACKEND_REDIRECT` - OAuth redirect URL
- `ADMIN_EMAIL` - Admin user email
- `OPENAI_API_KEY` - OpenAI API key for AI features
- `OPENAI_MODEL` - OpenAI model (default: gpt-4o)

### Setup Instructions

1. Create a Neon PostgreSQL database
2. Set all environment variables in Space settings
3. The app will automatically create tables on first run
4. GitHub OAuth app should be configured with callback URL:
   `https://your-space-name.huggingface.space/api/auth/github/callback`

## Local Development

1. Copy `.env.example` to `.env`
2. Fill in your environment variables
3. Install dependencies: `pip install -r requirements.txt`
4. Create tables: `python create_tables.py`
5. Run app: `python app.py`

## Tech Stack

- Backend: Flask, SQLAlchemy, PostgreSQL
- Frontend: HTML, CSS, JavaScript, Bootstrap
- Authentication: Flask-Login, OAuth
- AI: OpenAI GPT
- PDF Generation: ReportLab
- Deployment: Docker, Gunicorn

Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference