Back to Reactive Resume

Introduction to Reactive Resume

docs/getting-started.mdx

5.3.04.6 KB
Original Source
<Frame> </Frame>

What is Reactive Resume?

Reactive Resume is a free and open-source resume builder that makes it easy to create, update, and share your resume. Built with privacy as a core principle, it gives you complete control over your data.

<CardGroup cols={2}> <Card title="Privacy First" icon="shield-check"> Your data stays yours. No tracking, no ads, and an open-source codebase you can read. </Card> <Card title="Beautiful Templates" icon="palette"> Choose from a set of professionally designed templates. </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> </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 its own layout and style.
</Accordion>

<Accordion title="Rich Text Editor" icon="text">
	Format your content with bold, italic, links, lists, and more using the rich text editor, powered by Tiptap.
</Accordion>

<Accordion title="Multi-language Support" icon="globe">
	Reactive Resume is available in multiple languages. Contribute translations to help us reach more people.
</Accordion>

<Accordion title="Dark Mode" icon="moon">
	Built-in dark mode support, so you can work comfortably in any lighting condition.
</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

Use the hosted version, or run your own instance.

<CardGroup cols={2}> <Card title="Quickstart" icon="rocket" href="/getting-started/quickstart"> Start with the 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

CategoryTechnology
FrameworkTanStack Start (React 19, Vite)
RuntimeNode.js
LanguageTypeScript
DatabasePostgreSQL with Drizzle ORM
APIORPC (Type-safe RPC)
AuthBetter Auth
StylingTailwind CSS
UI ComponentsBase UI + shadcn-style package
State ManagementZustand + TanStack Query

Community & support

<CardGroup cols={2}> <Card title="GitHub" icon="github" href="https://github.com/amruthpillai/reactive-resume"> Star the repo, report reproducible bugs, propose features, and contribute to the project. </Card> <Card title="GitHub Discussions" icon="comments" href="https://github.com/amruthpillai/reactive-resume/discussions/categories/q-a"> Ask questions about setup, configuration, and using Reactive Resume. </Card> <Card title="Reddit" icon="reddit" href="https://reddit.com/r/reactiveresume"> Get help and talk to other users on our subreddit. </Card> <Card title="Discord" icon="discord" href="https://discord.gg/aSyA5ZSxpb"> Get help and talk to other users on our Discord server. </Card> <Card title="Sponsor" icon="heart" href="https://opencollective.com/reactive-resume/donate"> Help fund the continued development of Reactive Resume. </Card> </CardGroup> <Note> **Need help?** Start a [GitHub Discussion](https://github.com/amruthpillai/reactive-resume/discussions/categories/q-a). GitHub Issues are reserved for reproducible bugs and actionable feature proposals. </Note>