mirror of
https://github.com/AmruthPillai/Reactive-Resume.git
synced 2026-07-25 09:24:54 +10:00
use vite+
This commit is contained in:
Amruth Pillai
@@ -4,7 +4,7 @@ description: "Welcome to the documentation for Reactive Resume, a free and open-
|
||||
---
|
||||
|
||||
<Frame>
|
||||
<img src="/images/getting-started/banner.webp" alt="Reactive Resume Banner" />
|
||||
<img src="/images/getting-started/banner.webp" alt="Reactive Resume Banner" />
|
||||
</Frame>
|
||||
|
||||
## What is Reactive Resume?
|
||||
@@ -12,24 +12,24 @@ description: "Welcome to the documentation for Reactive Resume, a free and open-
|
||||
**Reactive Resume** is a free and open-source resume builder designed to simplify the process of creating, updating, and sharing your professional resume. Built with privacy as a core principle, it gives you complete control over your data while providing a powerful, modern experience.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Privacy First" icon="shield-check">
|
||||
Your data stays yours. No tracking, no ads, and complete transparency with our open-source codebase.
|
||||
</Card>
|
||||
<Card title="Beautiful Templates" icon="palette">
|
||||
Choose from professionally designed templates that make your resume stand out from the crowd.
|
||||
</Card>
|
||||
<Card title="Real-time Preview" icon="eye">
|
||||
See changes instantly as you type. What you see is exactly what you'll get when you export.
|
||||
</Card>
|
||||
<Card title="Export Anywhere" icon="file-export">
|
||||
Download your resume as PDF, share it via a unique link, or print it directly from your browser.
|
||||
</Card>
|
||||
<Card title="Privacy First" icon="shield-check">
|
||||
Your data stays yours. No tracking, no ads, and complete transparency with our open-source codebase.
|
||||
</Card>
|
||||
<Card title="Beautiful Templates" icon="palette">
|
||||
Choose from professionally designed templates that make your resume stand out from the crowd.
|
||||
</Card>
|
||||
<Card title="Real-time Preview" icon="eye">
|
||||
See changes instantly as you type. What you see is exactly what you'll get when you export.
|
||||
</Card>
|
||||
<Card title="Export Anywhere" icon="file-export">
|
||||
Download your resume as PDF, share it via a unique link, or print it directly from your browser.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Key Features
|
||||
|
||||
<Frame>
|
||||
<img src="/images/getting-started/infographic.webp" alt="An infographic of the major features of Reactive Resume" />
|
||||
<img src="/images/getting-started/infographic.webp" alt="An infographic of the major features of Reactive Resume" />
|
||||
</Frame>
|
||||
|
||||
<AccordionGroup>
|
||||
@@ -68,12 +68,12 @@ description: "Welcome to the documentation for Reactive Resume, a free and open-
|
||||
Whether you want to use our hosted version or run your own instance, Reactive Resume has got you covered.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Quickstart" icon="rocket" href="/getting-started/quickstart">
|
||||
Get up and running in minutes with our hosted version or deploy your own instance.
|
||||
</Card>
|
||||
<Card title="Development Setup" icon="code" href="/contributing/development">
|
||||
Set up a local development environment to contribute or customize Reactive Resume.
|
||||
</Card>
|
||||
<Card title="Quickstart" icon="rocket" href="/getting-started/quickstart">
|
||||
Get up and running in minutes with our hosted version or deploy your own instance.
|
||||
</Card>
|
||||
<Card title="Development Setup" icon="code" href="/contributing/development">
|
||||
Set up a local development environment to contribute or customize Reactive Resume.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Tech Stack
|
||||
@@ -95,20 +95,20 @@ Reactive Resume is built with modern web technologies:
|
||||
## Community & Support
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="GitHub" icon="github" href="https://github.com/amruthpillai/reactive-resume">
|
||||
Star the repo, report issues, and contribute to the project.
|
||||
</Card>
|
||||
<Card title="Reddit" icon="reddit" href="https://reddit.com/r/reactiveresume">
|
||||
Join our Reddit community to get help and connect with other users.
|
||||
</Card>
|
||||
<Card title="Discord" icon="discord" href="https://discord.gg/aSyA5ZSxpb">
|
||||
Join our Discord server to get help and connect with other users.
|
||||
</Card>
|
||||
<Card title="Sponsor" icon="heart" href="https://opencollective.com/reactive-resume">
|
||||
Support the development and long-term sustainability of Reactive Resume.
|
||||
</Card>
|
||||
<Card title="GitHub" icon="github" href="https://github.com/amruthpillai/reactive-resume">
|
||||
Star the repo, report issues, and contribute to the project.
|
||||
</Card>
|
||||
<Card title="Reddit" icon="reddit" href="https://reddit.com/r/reactiveresume">
|
||||
Join our Reddit community to get help and connect with other users.
|
||||
</Card>
|
||||
<Card title="Discord" icon="discord" href="https://discord.gg/aSyA5ZSxpb">
|
||||
Join our Discord server to get help and connect with other users.
|
||||
</Card>
|
||||
<Card title="Sponsor" icon="heart" href="https://opencollective.com/reactive-resume">
|
||||
Support the development and long-term sustainability of Reactive Resume.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
<Note>
|
||||
**Need help?** Feel free to reach out via [email](mailto:hello@amruthpillai.com) or open an issue on GitHub.
|
||||
**Need help?** Feel free to reach out via [email](mailto:hello@amruthpillai.com) or open an issue on GitHub.
|
||||
</Note>
|
||||
|
||||
@@ -8,12 +8,12 @@ description: "Get started with Reactive Resume in minutes — use our hosted ver
|
||||
Reactive Resume offers flexibility in how you want to use it. Choose the option that best fits your needs:
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Use the Cloud Version" icon="cloud" href="#use-the-cloud-version">
|
||||
The fastest way to get started. **Recommended for most users.**
|
||||
</Card>
|
||||
<Card title="Self-Host with Docker" icon="docker" href="#self-host-with-docker">
|
||||
Deploy your own instance with complete control. **Requires some technical knowledge.**
|
||||
</Card>
|
||||
<Card title="Use the Cloud Version" icon="cloud" href="#use-the-cloud-version">
|
||||
The fastest way to get started. **Recommended for most users.**
|
||||
</Card>
|
||||
<Card title="Self-Host with Docker" icon="docker" href="#self-host-with-docker">
|
||||
Deploy your own instance with complete control. **Requires some technical knowledge.**
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
---
|
||||
@@ -59,8 +59,8 @@ Before you begin, ensure you have the following installed:
|
||||
- [Docker Compose](https://docs.docker.com/compose/install/) (v2.0 or higher)
|
||||
|
||||
<Info>
|
||||
There is <strong>no difference in features</strong> between the cloud-hosted version and the self-hosted option. Both
|
||||
provide the same privacy, customization, and functionality. Choose whichever deployment type suits your needs!
|
||||
There is <strong>no difference in features</strong> between the cloud-hosted version and the self-hosted option. Both
|
||||
provide the same privacy, customization, and functionality. Choose whichever deployment type suits your needs!
|
||||
</Info>
|
||||
|
||||
### Quick Deployment
|
||||
@@ -166,17 +166,17 @@ Here's a complete list of environment variables you can configure:
|
||||
> **Note:** Some variables are only required for using related features (OAuth, SMTP, S3, etc.) and can be left unset if unused.
|
||||
|
||||
<Note>
|
||||
**Hybrid Setup Note**: The `PRINTER_APP_URL` variable is required when running Reactive Resume outside of Docker while
|
||||
the printer service is running inside Docker. In this scenario, the printer needs to reach your local app to render
|
||||
resumes for PDF generation. Since Docker containers cannot access `localhost` on your host machine directly, you must
|
||||
set `PRINTER_APP_URL` to `http://host.docker.internal:3000`. This special hostname allows Docker containers to
|
||||
communicate with services running on your host machine.
|
||||
**Hybrid Setup Note**: The `PRINTER_APP_URL` variable is required when running Reactive Resume outside of Docker while
|
||||
the printer service is running inside Docker. In this scenario, the printer needs to reach your local app to render
|
||||
resumes for PDF generation. Since Docker containers cannot access `localhost` on your host machine directly, you must
|
||||
set `PRINTER_APP_URL` to `http://host.docker.internal:3000`. This special hostname allows Docker containers to
|
||||
communicate with services running on your host machine.
|
||||
</Note>
|
||||
|
||||
<Note>
|
||||
**Alternative Printer Options**: If you don't want to use browserless, you can use any headless Chrome/Chromium
|
||||
instance with its remote debugging port open. For example, run `chromium --remote-debugging-port=9222` and point
|
||||
`PRINTER_ENDPOINT` to that instance.
|
||||
**Alternative Printer Options**: If you don't want to use browserless, you can use any headless Chrome/Chromium
|
||||
instance with its remote debugging port open. For example, run `chromium --remote-debugging-port=9222` and point
|
||||
`PRINTER_ENDPOINT` to that instance.
|
||||
</Note>
|
||||
|
||||
---
|
||||
@@ -184,15 +184,15 @@ Here's a complete list of environment variables you can configure:
|
||||
## Next Steps
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Development Setup" icon="code" href="/contributing/development">
|
||||
Set up a development environment to contribute or customize Reactive Resume.
|
||||
</Card>
|
||||
<Card title="Project Architecture" icon="folder-open" href="/contributing/architecture">
|
||||
Learn about the project structure and architecture.
|
||||
</Card>
|
||||
<Card title="Development Setup" icon="code" href="/contributing/development">
|
||||
Set up a development environment to contribute or customize Reactive Resume.
|
||||
</Card>
|
||||
<Card title="Project Architecture" icon="folder-open" href="/contributing/architecture">
|
||||
Learn about the project structure and architecture.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
<Note>
|
||||
**Having trouble?** Check our [GitHub Issues](https://github.com/amruthpillai/reactive-resume/issues) or reach out via
|
||||
[email](mailto:hello@amruthpillai.com).
|
||||
**Having trouble?** Check our [GitHub Issues](https://github.com/amruthpillai/reactive-resume/issues) or reach out via
|
||||
[email](mailto:hello@amruthpillai.com).
|
||||
</Note>
|
||||
|
||||
Reference in New Issue
Block a user