https://github.com/sarvamm/rescueme
Quickly generate a high ATS score resumé.
https://github.com/sarvamm/rescueme
latex pdf resume resume-generator resume-template streamlit
Last synced: 4 months ago
JSON representation
Quickly generate a high ATS score resumé.
- Host: GitHub
- URL: https://github.com/sarvamm/rescueme
- Owner: Sarvamm
- License: other
- Created: 2025-04-14T03:38:16.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-17T10:05:28.000Z (6 months ago)
- Last Synced: 2025-05-30T00:07:37.964Z (5 months ago)
- Topics: latex, pdf, resume, resume-generator, resume-template, streamlit
- Language: Python
- Homepage:
- Size: 158 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Create beautiful, professional resumes using LaTeX – no LaTeX knowledge required!
RescueMé! is a web app built with [Streamlit](https://streamlit.io/) that lets you fill out a form and instantly generate a polished PDF resume using a LaTeX template. It’s fast, open-source, and easy to use.
## 📦 Features
- Fill in your resume content using simple forms
- Auto-generate `.tex` source file from inputs
- Compiles LaTeX to high-quality PDF resume
- Download the final PDF instantly
---
## 🛠 Installation & Setup
### 1. Clone the Repository
```bash
git clone https://github.com/sarvamm/rescueme.git
cd rescueme
```
### 2. Install Python Dependencies
```bash
pip install -r requirements.txt
```
Or manually:
```bash
pip install streamlit
```
> Other libraries used (`os`, `base64`, `subprocess`, `tempfile`) are part of the Python standard library.
---
### 3. Install a LaTeX Compiler
The app uses `pdflatex` to compile LaTeX into PDF.
#### Windows
- Install [MiKTeX](https://miktex.org/download)
- Ensure `pdflatex` is added to your system `PATH`
- Test it:
```bash
pdflatex --version
```
#### Linux
```bash
sudo apt update
sudo apt install texlive-latex-base
```
#### macOS
```bash
brew install --cask mactex
```
Or get MacTeX from [https://tug.org/mactex/](https://tug.org/mactex/)
---
## Run the App
```bash
streamlit run app.py
```
The app will open at `http://localhost:8501` in your browser.
---
## 📁 Project Structure
```
RESCUEME/
│
├── .streamlit/
│ └── config.toml # Streamlit app config (title, icon, etc.)
│
├── assets/
│ └── logo.png # App logo
│
├── pages/ # Multi-page structure for Streamlit
│ ├── About.py # About page of RescueMé!
│ ├── GetStarted.py # Setup & installation instructions
│ └── Main.py # Main functionality (resume generation)
│
├── App.py # Entry point of the Streamlit app
├── LICENSE # MIT License for open-source usage
├── readme.md # Project overview and usage guide
└── Requirement.txt # Python dependencies
```
## 🤝 Contributing
Pull requests are welcome! Feel free to fork the repo, make improvements, and submit a PR.
For major changes, please open an issue first to discuss what you’d like to change.
---
## 📬 Contact
🔗 [LinkedIn](https://www.linkedin.com/in/sarvamm) • [GitHub](https://github.com/sarvamm) • [Buy me a Coffee](https://buymeacoffee.com/astrayn)
---
## 📃 License
This project is licensed under the Non-Profit Open Software License version 3.0