mirror of
https://github.com/AmruthPillai/Reactive-Resume.git
synced 2026-06-22 04:11:55 +10:00
Amruth Pillai
115 lines
4.8 KiB
Plaintext
115 lines
4.8 KiB
Plaintext
---
|
|
title: "Introduction"
|
|
description: "Welcome to the documentation for Reactive Resume, a free and open-source resume builder that simplifies the process of creating, updating, and sharing your resume."
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/getting-started/banner.webp" alt="Reactive Resume Banner" />
|
|
</Frame>
|
|
|
|
## What is Reactive Resume?
|
|
|
|
**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>
|
|
</CardGroup>
|
|
|
|
## Key Features
|
|
|
|
<Frame>
|
|
<img src="/images/getting-started/infographic.webp" alt="An infographic of the major features of Reactive Resume" />
|
|
</Frame>
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Completely Free & Open Source" icon="code-branch">
|
|
Reactive Resume is licensed under MIT. You can use it for free, modify it, and even host your own instance. The
|
|
entire codebase is available on [GitHub](https://github.com/amruthpillai/reactive-resume).
|
|
</Accordion>
|
|
|
|
<Accordion title="Multiple Templates" icon="grid-2">
|
|
Choose from a variety of professionally designed templates including Azurill, Bronzor, Chikorita, Ditgar, Ditto,
|
|
Gengar, Glalie, Kakuna, Lapras, Leafish, Meowth, Onyx, Pikachu, Rhyhorn, and Scizor - each with unique layouts and styles.
|
|
</Accordion>
|
|
|
|
<Accordion title="Rich Text Editor" icon="text">
|
|
Format your content with bold, italic, links, lists, and more using our intuitive rich text editor powered by
|
|
Tiptap.
|
|
</Accordion>
|
|
|
|
<Accordion title="Multi-language Support" icon="globe">
|
|
Reactive Resume supports multiple languages, making it accessible to users worldwide. Contribute translations to
|
|
help us reach more people.
|
|
</Accordion>
|
|
|
|
<Accordion title="Dark Mode" icon="moon">
|
|
Work comfortably in any lighting condition with built-in dark mode support that's easy on your eyes.
|
|
</Accordion>
|
|
|
|
<Accordion title="Self-hosting Ready" icon="server">
|
|
Deploy your own instance of Reactive Resume using Docker. Keep complete control over your data and infrastructure.
|
|
</Accordion>
|
|
|
|
</AccordionGroup>
|
|
|
|
## Getting Started
|
|
|
|
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>
|
|
</CardGroup>
|
|
|
|
## Tech Stack
|
|
|
|
Reactive Resume is built with modern web technologies:
|
|
|
|
| Category | Technology |
|
|
| ---------------- | ------------------------------- |
|
|
| Framework | TanStack Start (React 19, Vite) |
|
|
| Runtime | Node.js |
|
|
| Language | TypeScript |
|
|
| Database | PostgreSQL with Drizzle ORM |
|
|
| API | ORPC (Type-safe RPC) |
|
|
| Auth | Better Auth |
|
|
| Styling | Tailwind CSS |
|
|
| UI Components | Radix UI |
|
|
| State Management | Zustand + TanStack Query |
|
|
|
|
## 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/donate">
|
|
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.
|
|
</Note>
|