mirror of
https://github.com/AmruthPillai/Reactive-Resume.git
synced 2026-06-22 04:11:55 +10:00
Amruth Pillai
6d8d8f6e55
* chore(ai): remove local AI store now that providers live server-side
The Zustand-based useAIStore has been replaced by the server-side
aiProviders oRPC router (encrypted credentials persisted in DB).
Delete the dead store + tests, drop the ./store export, and remove
zustand/immer deps which are no longer referenced anywhere in
packages/ai/src/.
* feat(agent): archive/delete actions and read-only state for agent threads
- Backend: mark archived threads as read-only in threads.get and reject
messages.send with CONFLICT when the thread is archived.
- Frontend: render archived threads in the sidebar with muted styling and
an Archived badge; add a per-thread dropdown menu in the chat header
with Archive (non-destructive) and Delete (with confirmation); show a
read-only banner above the message list that disambiguates archived
vs. missing-resource causes; suppress the Retry and Stop buttons in
read-only mode.
- Tests: new packages/api/src/services/agent.test.ts covering the
archived-thread isReadOnly flag and the archived-thread send refusal.
* fix(agent): abort run on archive and verify ownership before deleting thread
- threads.archive: before flipping status, abort any in-flight run controller
and clear the active-run state on the thread; cleanup failures are logged
but do not block the status update.
- threads.delete: assert thread ownership via getThread before destructive
work so an authenticated user cannot wipe another user's attachment rows
by passing a foreign threadId.
Adds focused tests for both behaviors.
* feat(agent): display patch diffs and surface revert conflicts
Render apply_resume_patch tool messages with a status-aware card (applied/
reverted/conflicted), expandable operation list, and a Revert button that
correctly handles RESUME_VERSION_CONFLICT responses. Adds unit tests for
the inverse-patch builder and the agentService.actions.revert flow.
* chore(agent): remove out-of-scope attachment tests accidentally added in Task 6
The Task 6 commit (73ef1acca) accidentally re-introduced three attachment-
related tests that belong to a separate task:
- `buildAttachmentModelParts > converts text, image, supported binary, and
unsupported attachments into model parts`
- `agentService.messages.send > persists the user message with file UI parts
and links selected attachments to it` (was failing — the `ToolLoopAgent`
mock is not callable as a constructor)
- `agentService.messages.send > rejects attachments that are missing, foreign,
or already linked before persisting a message`
These were likely re-added during a stash recovery and were not requested
for Task 6, whose scope was limited to the `agentService.actions.revert`
flow. Remove them along with the helpers/fixtures (`buildAttachment`,
`buildActiveThread`, `selectWhereResult`, `selectOrderByResult`) that they
were the only consumers of. `selectLimitResult` is preserved because it is
used by the revert tests.
* chore(agent): configure runtime dependencies
* feat(db): add agent workspace schema
* feat(api): add agent backend services
* feat(web): add agent workspace UI
* chore(agent): remove legacy builder assistant
* test(agent): make agent stream mocks constructible
* chore(web): remove unused resume replacement hook
* feat(api): add unsafe AI base URL flag
* chore(dev): expose local services in compose
* fix(web): normalize resume preview gaps
* feat(api): improve agent tool handling
* feat(web): polish agent workspace UI
* chore: update dependencies
* fix(api,web): address PR review feedback for agent workspace
Security/correctness:
- Restrict AI provider URLs to http/https even in unsafe mode
- Stop exposing Redis on host network by default
- Make .env.local optional and drop app profile in compose.dev.yml
- Store agent attachments with private ACL on S3
- Reset provider test status when provider/model/baseURL changes
- Decouple non-agent AI endpoints from REDIS_URL requirement
- Fix JSON Patch add inverse for existing object members
- Wrap resume patch + agent action insert in db transaction
- Validate partialMessage at runtime and rate-limit attachment uploads
- Add unique index on agent_messages (thread_id, sequence)
UX/bugs:
- Mark agent thread route as ssr: false and guard SSE chunk parsing
- Show config-specific banner only on known configuration error
- Gate AI provider checks behind loading state in resume import
- Fix relative-time formatter blank gap between 45-59 seconds
- Clarify thread delete confirmation message
Polish:
- Raise ENCRYPTION_SECRET minimum to 32 characters
- Bucket AI rate limits by resumeId/threadId/messageId
- Trim form values before submitting AI provider config
- Use single key identifier and nullish-coalesce baseURL display
* fix: address ai agent review feedback
* fix: preserve mobile agent chat state
* docs: add ai agent workspace guides
* feat: introduce design system for Reactive Resume
240 lines
12 KiB
Plaintext
240 lines
12 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Get started with Reactive Resume in minutes — use our hosted version or deploy your own instance"
|
|
---
|
|
|
|
## Options
|
|
|
|
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>
|
|
</CardGroup>
|
|
|
|
---
|
|
|
|
## Using the Cloud Version
|
|
|
|
The easiest way to use Reactive Resume is through our cloud version at [rxresu.me](https://rxresu.me). **This service is completely free and will always remain free.**
|
|
|
|
<Steps>
|
|
<Step title="Create an Account">
|
|
Visit [rxresu.me](https://rxresu.me) and sign up for free using your email, or sign in with your GitHub or Google
|
|
account.
|
|
</Step>
|
|
|
|
<Step title="Create Your First Resume">
|
|
Click the **Create Resume** button on your dashboard. Give your resume a name and select a template to get started.
|
|
</Step>
|
|
|
|
<Step title="Fill in Your Details">
|
|
Use our intuitive builder to add your: - Personal information - Work experience - Education - Skills - Projects -
|
|
And more...
|
|
</Step>
|
|
|
|
<Step title="Export & Share">
|
|
When you're ready, export your resume as a PDF or share it via a unique public link.
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
<Tip>Your resume updates in real-time as you type. The preview panel shows exactly how your final PDF will look.</Tip>
|
|
|
|
---
|
|
|
|
## Self-Host with Docker
|
|
|
|
For users who prefer complete control over their data, you can deploy Reactive Resume on your own infrastructure using Docker.
|
|
|
|
<Info>
|
|
**From v5.1.0 onwards** — PDF generation now runs entirely client-side via `@react-pdf/renderer`. Self-hosted deployments no longer require Browserless, Chromium, or any external print service as a dependency. The `PRINTER_*` and `BROWSERLESS_*` environment variables are no longer read and can be removed from your `.env`.
|
|
</Info>
|
|
|
|
### Prerequisites
|
|
|
|
Before you begin, ensure you have the following installed:
|
|
|
|
- [Docker](https://docs.docker.com/get-docker/) (v20.10 or higher)
|
|
- [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!
|
|
</Info>
|
|
|
|
### Quick Deployment
|
|
|
|
<Steps>
|
|
<Step title="Clone the Repository">
|
|
```bash
|
|
git clone https://github.com/amruthpillai/reactive-resume.git
|
|
cd Reactive-Resume
|
|
```
|
|
</Step>
|
|
|
|
<Step title="Configure Environment Variables">
|
|
Create a `.env` file in the root directory with the following variables:
|
|
|
|
```bash .env
|
|
# Application
|
|
APP_URL=http://localhost:3000
|
|
|
|
# Database
|
|
DATABASE_URL=postgresql://postgres:postgres@postgres:5432/postgres
|
|
|
|
# Authentication (generate a secure secret)
|
|
AUTH_SECRET=your-secure-secret-key-here
|
|
|
|
# Storage (S3-compatible via SeaweedFS)
|
|
S3_ACCESS_KEY_ID=seaweedfs
|
|
S3_SECRET_ACCESS_KEY=seaweedfs
|
|
S3_ENDPOINT=http://seaweedfs:8333
|
|
S3_BUCKET=reactive-resume
|
|
S3_FORCE_PATH_STYLE=true
|
|
|
|
# AI features (optional; ENCRYPTION_SECRET for saved providers, plus REDIS_URL for the agent)
|
|
REDIS_URL=redis://redis:6379
|
|
ENCRYPTION_SECRET=your-secure-encryption-secret-here
|
|
```
|
|
|
|
<Warning>
|
|
For production deployments, always use strong, unique values for `AUTH_SECRET`, `ENCRYPTION_SECRET`, and
|
|
database credentials.
|
|
</Warning>
|
|
</Step>
|
|
|
|
<Step title="Start the Services">
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
This starts:
|
|
- **PostgreSQL** — Database for storing user data and resumes
|
|
- **Redis** — Required for the AI Agent workspace
|
|
- **SeaweedFS** — S3-compatible storage for file uploads
|
|
- **Reactive Resume** — The main application
|
|
</Step>
|
|
|
|
<Step title="Access Your Instance">
|
|
Once all services are running, access your Reactive Resume instance at:
|
|
|
|
```text
|
|
http://localhost:3000
|
|
```
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
### Docker Compose Services
|
|
|
|
Here's what each service in the stack does:
|
|
|
|
| Service | Port | Description |
|
|
| ----------------- | ---- | ---------------------------------------------------- |
|
|
| `postgres` | 5432 | PostgreSQL database for storing all application data |
|
|
| `redis` | 6379 | Redis instance required by the AI Agent workspace |
|
|
| `seaweedfs` | 8333 | S3-compatible object storage for file uploads |
|
|
| `reactive_resume` | 3000 | The main Reactive Resume application |
|
|
|
|
<Note>
|
|
Saved AI provider management requires `ENCRYPTION_SECRET`, and the AI Agent workspace requires both `REDIS_URL` and
|
|
`ENCRYPTION_SECRET`. Other Reactive Resume features can run without them. Agent attachments and other private objects
|
|
require S3-compatible storage; local storage rejects private objects.
|
|
</Note>
|
|
|
|
### Health Checks
|
|
|
|
All services include built-in health checks. You can verify everything is running correctly:
|
|
|
|
```bash
|
|
docker compose ps
|
|
```
|
|
|
|
You should see all services with a `healthy` status.
|
|
|
|
---
|
|
|
|
## Environment Variables Reference
|
|
|
|
Here's a complete list of environment variables you can configure:
|
|
|
|
### Required Variables
|
|
|
|
| Variable | Description | Example |
|
|
| -------------- | ------------------------------ | ------------------------------------- |
|
|
| `DATABASE_URL` | PostgreSQL connection string | `postgresql://user:pass@host:5432/db` |
|
|
| `AUTH_SECRET` | Secret key for authentication | Generate with `openssl rand -hex 32` |
|
|
| `APP_URL` | Public URL of your Application | `https://rxresu.me` |
|
|
|
|
### Optional Variables
|
|
|
|
| Variable | Description | Default |
|
|
| ------------------------------------- | ----------------------------------------------------------- | ---------------------- |
|
|
| `GOOGLE_CLIENT_ID` | Google OAuth Client ID | — |
|
|
| `GOOGLE_CLIENT_SECRET` | Google OAuth Client Secret | — |
|
|
| `GITHUB_CLIENT_ID` | GitHub OAuth Client ID | — |
|
|
| `GITHUB_CLIENT_SECRET` | GitHub OAuth Client Secret | — |
|
|
| `LINKEDIN_CLIENT_ID` | LinkedIn OAuth Client ID | — |
|
|
| `LINKEDIN_CLIENT_SECRET` | LinkedIn OAuth Client Secret | — |
|
|
| `OAUTH_PROVIDER_NAME` | Custom OAuth Provider Name | — |
|
|
| `OAUTH_CLIENT_ID` | Custom OAuth Client ID | — |
|
|
| `OAUTH_CLIENT_SECRET` | Custom OAuth Client Secret | — |
|
|
| `OAUTH_DISCOVERY_URL` | OIDC Discovery URL (use this OR manual URLs below) | — |
|
|
| `OAUTH_AUTHORIZATION_URL` | OAuth Authorization URL (manual config) | — |
|
|
| `OAUTH_TOKEN_URL` | OAuth Token URL (manual config) | — |
|
|
| `OAUTH_USER_INFO_URL` | OAuth User Info URL (manual config) | — |
|
|
| `OAUTH_DYNAMIC_CLIENT_REDIRECT_HOSTS` | Trusted HTTPS hosts/origins for dynamic OAuth redirects | — |
|
|
| `OAUTH_SCOPES` | OAuth Scopes (space-separated) | `openid profile email` |
|
|
| `BETTER_AUTH_API_KEY` | Better Auth dashboard API key | — |
|
|
| `BETTER_AUTH_URL` | Better Auth base URL override (advanced) | `APP_URL` |
|
|
| `BETTER_AUTH_SECRET` | Better Auth secret override (advanced) | `AUTH_SECRET` |
|
|
| `SMTP_HOST` | SMTP Server Host (for email features) | — |
|
|
| `SMTP_PORT` | SMTP Server Port | `587` |
|
|
| `SMTP_USER` | SMTP Username | — |
|
|
| `SMTP_PASS` | SMTP Password | — |
|
|
| `SMTP_FROM` | Default FROM address for emails | — |
|
|
| `SMTP_SECURE` | Use secure SMTP connection (`true` or `false`) | `false` |
|
|
| `S3_ACCESS_KEY_ID` | S3 Access Key | — |
|
|
| `S3_SECRET_ACCESS_KEY` | S3 Secret Key | — |
|
|
| `S3_REGION` | S3 Region | `us-east-1` |
|
|
| `S3_ENDPOINT` | S3-compatible Endpoint URL | — |
|
|
| `S3_BUCKET` | S3 Bucket Name | — |
|
|
| `S3_FORCE_PATH_STYLE` | Use path-style URLs for S3 (set `true` for MinIO/SeaweedFS) | `false` |
|
|
| `REDIS_URL` | Redis connection string for the AI Agent workspace | — |
|
|
| `ENCRYPTION_SECRET` | Encryption secret for saved AI provider credentials | — |
|
|
| `CLOUDFLARE_ACCOUNT_ID` | Optional Cloudflare URL extraction fallback account ID | — |
|
|
| `CLOUDFLARE_API_TOKEN` | Optional Cloudflare URL extraction fallback API token | — |
|
|
| `FLAG_DISABLE_SIGNUPS` | Disables new user signups | `false` |
|
|
| `FLAG_DISABLE_EMAIL_AUTH` | Disables email/password login (SSO only) | `false` |
|
|
| `FLAG_DISABLE_IMAGE_PROCESSING` | Disables image processing | `false` |
|
|
| `FLAG_ALLOW_UNSAFE_AI_BASE_URL` | Allows unsafe/private/non-public AI provider base URLs | `false` |
|
|
|
|
> **Note:** Some variables are only required for using related features (OAuth, SMTP, S3, etc.) and can be left unset if unused.
|
|
|
|
> **AI features:** Saved AI provider management requires `ENCRYPTION_SECRET`, and the AI Agent workspace requires both `REDIS_URL` and `ENCRYPTION_SECRET`. Cloudflare variables only enable the optional URL extraction fallback and are not required for normal agent operation. Keep `FLAG_ALLOW_UNSAFE_AI_BASE_URL` disabled unless this is a trusted self-hosted deployment; public HTTPS provider URLs are the safe default.
|
|
|
|
> **Health check behavior:** `/api/health` reports status for database and storage. A failure in either dependency returns HTTP `503`.
|
|
|
|
---
|
|
|
|
## 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>
|
|
</CardGroup>
|
|
|
|
<Note>
|
|
**Having trouble?** Check our [GitHub Issues](https://github.com/amruthpillai/reactive-resume/issues) or reach out via
|
|
[email](mailto:hello@amruthpillai.com).
|
|
</Note>
|