Quick Start
Initial steps for deploying or developing with the VeriWorkly platform.
Quick Start
VeriWorkly is a full-stack platform comprising a Next.js frontend and an Express.js backend. The architecture is designed for high-fidelity document rendering and secure data synchronization.
Implementation Paths
Select the deployment or development path that aligns with your requirements:
Local Development
Recommended for developers and contributors. Run the platform services manually to modify source code, test features, or design templates.
Docker Deployment
Recommended for production environments and self-hosters. Deploy the complete ecosystem utilizing our optimized Docker Compose configuration.
Project Structure
VeriWorkly utilizes a monorepo architecture to manage independent services and shared packages efficiently.
Architectural Components
The platform consists of several integrated components:
- Marketing Site (Site): A Next.js application handling landing pages and public content.
- Resume Studio (Studio): The primary Next.js application handling user interaction, local-first state management, and high-fidelity document rendering.
- Backend API (Server): An Express-based service managing authentication and secure data synchronization.
- Database (PostgreSQL): The primary relational store. We recommend Neon for managed deployments.
- PDF Engine (react-pdf): A client-side rendering library that generates ATS-optimized documents directly in the browser.