Spaces:
Configuration error
Configuration error
Commit
·
b1174ec
1
Parent(s):
d124531
Cleaned up
Browse files
README.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
| 4 |
|
| 5 |
Resumate is a simple web app that helps you generate a tailored resume for a specific job post. It collects your LinkedIn profile (PDF export), GitHub profile URL, and the job post text, then processes this information to help you create a resume that matches the job requirements.
|
| 6 |
|
|
|
|
| 7 |
## Features
|
| 8 |
- Upload your LinkedIn resume export (PDF)
|
| 9 |
- Provide your GitHub profile URL (public repos only)
|
|
@@ -11,27 +12,27 @@ Resumate is a simple web app that helps you generate a tailored resume for a spe
|
|
| 11 |
- Optionally add custom instructions for the resume writer agent
|
| 12 |
- Get a tailored resume output in seconds
|
| 13 |
|
| 14 |
-
---
|
| 15 |
|
| 16 |
## Quickstart (Recommended: GitHub Codespaces)
|
| 17 |
|
| 18 |
1. **Fork this repository**
|
| 19 |
- Click the "Fork" button on GitHub to create your own copy of the repository.
|
|
|
|
| 20 |
2. **Add API keys as secrets**
|
| 21 |
- In your fork, go to **Settings > Secrets and variables > Codespaces**.
|
| 22 |
- Add secrets named `OPENAI_API_KEY` and `MODAL_API_KEY` with your API keys as values.
|
| 23 |
- These will be available as environment variables in your Codespace.
|
|
|
|
| 24 |
3. **Start a Codespace**
|
| 25 |
- Click the "Code" button on your fork and select "Open with Codespaces".
|
| 26 |
- Codespaces will automatically set up the environment.
|
| 27 |
-
4. **Open the provided URL** in your browser to use the Gradio UI.
|
| 28 |
|
| 29 |
-
|
| 30 |
|
| 31 |
-
## Running Locally with Virtualenv
|
| 32 |
|
|
|
|
| 33 |
|
| 34 |
-
|
| 35 |
|
| 36 |
1. **Fork this repository:**
|
| 37 |
Click the "Fork" button on GitHub to create your own copy of the repository.
|
|
@@ -64,7 +65,6 @@ Resumate is a simple web app that helps you generate a tailored resume for a spe
|
|
| 64 |
```
|
| 65 |
8. **Open the provided URL** in your browser to use the Gradio UI.
|
| 66 |
|
| 67 |
-
---
|
| 68 |
|
| 69 |
## LinkedIn PDF Export Instructions
|
| 70 |
1. Go to your LinkedIn profile page
|
|
|
|
| 4 |
|
| 5 |
Resumate is a simple web app that helps you generate a tailored resume for a specific job post. It collects your LinkedIn profile (PDF export), GitHub profile URL, and the job post text, then processes this information to help you create a resume that matches the job requirements.
|
| 6 |
|
| 7 |
+
|
| 8 |
## Features
|
| 9 |
- Upload your LinkedIn resume export (PDF)
|
| 10 |
- Provide your GitHub profile URL (public repos only)
|
|
|
|
| 12 |
- Optionally add custom instructions for the resume writer agent
|
| 13 |
- Get a tailored resume output in seconds
|
| 14 |
|
|
|
|
| 15 |
|
| 16 |
## Quickstart (Recommended: GitHub Codespaces)
|
| 17 |
|
| 18 |
1. **Fork this repository**
|
| 19 |
- Click the "Fork" button on GitHub to create your own copy of the repository.
|
| 20 |
+
|
| 21 |
2. **Add API keys as secrets**
|
| 22 |
- In your fork, go to **Settings > Secrets and variables > Codespaces**.
|
| 23 |
- Add secrets named `OPENAI_API_KEY` and `MODAL_API_KEY` with your API keys as values.
|
| 24 |
- These will be available as environment variables in your Codespace.
|
| 25 |
+
|
| 26 |
3. **Start a Codespace**
|
| 27 |
- Click the "Code" button on your fork and select "Open with Codespaces".
|
| 28 |
- Codespaces will automatically set up the environment.
|
|
|
|
| 29 |
|
| 30 |
+
4. **Open the provided URL** in your browser to use the Gradio UI.
|
| 31 |
|
|
|
|
| 32 |
|
| 33 |
+
## Running Locally with virtualenv
|
| 34 |
|
| 35 |
+
**Note:** The following instructions are for Linux systems. Python 3.10 or greater is required.
|
| 36 |
|
| 37 |
1. **Fork this repository:**
|
| 38 |
Click the "Fork" button on GitHub to create your own copy of the repository.
|
|
|
|
| 65 |
```
|
| 66 |
8. **Open the provided URL** in your browser to use the Gradio UI.
|
| 67 |
|
|
|
|
| 68 |
|
| 69 |
## LinkedIn PDF Export Instructions
|
| 70 |
1. Go to your LinkedIn profile page
|