Migration to VeriWorkly v3

The transition to VeriWorkly v3 introduces a standardized monorepo architecture designed to enhance service isolation, maintainability, and resource sharing. This guide outlines the mandatory steps for migrating existing development environments to the current project structure.

Architectural Modifications

1. Unified Monorepo Structure

The project has transitioned from the legacy v2.x structure (apps/resume-builder) to a consolidated npm workspaces model. All core services are now located within the apps/ directory:

• apps/site: The marketing landing site.
• apps/studio: The resume builder editor application.
• apps/server: The centralized Express.js API.
• apps/docs-platform: The technical documentation platform.
• apps/blog-platform: The product blog.
• packages/ui: The shared design system and component library.

2. Operational Workflow

Deployment and development commands are now orchestrated from the root workspace directory.

Legacy Workflow (v2.x):

npm run dev:resume    # Scoped execution for the legacy builder

Current Workflow (v3.x):

npm run dev           # Initializes the landing site
npm run dev:all       # Initializes all workspace applications concurrently
npm run dev:site      # Scoped execution for the landing site
npm run dev:studio    # Scoped execution for the builder editor
npm run dev:server    # Scoped execution for the API service

Migration Protocol

1. Repository Synchronization

Ensure your local branch is synchronized with the upstream repository and reset the dependency tree to prevent workspace conflicts.

git pull origin master
rm -rf node_modules
npm install

2. Environment Configuration

Environment variables are now scoped to individual applications. Refer to the .env.example files within the root and respective apps/ directories for the required configuration keys.

3. Database Schema Alignment

The v3.x release includes significant modifications to the Prisma schema. Execute the following command to synchronize your local database instance with the current data model:

npm run db:push -w @veriworkly/server

Strategic Rationale

• Horizontal Scalability: Individual services, such as the PDF rendering worker, can be scaled independently of the web frontend.
• Visual Consistency: The centralized packages/ui library ensures design token parity across all user interfaces.
• Type Safety: The monorepo structure facilitates cross-workspace type sharing, reducing the risk of API-related runtime errors.