Local Development Setup
Technical guide for configuring the VeriWorkly development environment.
Local Development Setup
This guide provides comprehensive instructions for configuring a local development environment. This path is intended for developers, contributors, and those wishing to customize the platform's core functionality.
Prerequisites
Before initialization, ensure the following dependencies are installed:
- Node.js: Version 20 or higher is required.
- Package Manager: NPM (recommended), PNPM, or Yarn.
- PostgreSQL: A valid connection string is required. We recommend Neon for a managed serverless experience.
- Redis: Utilized for rate limiting and API caching. Not required for core resume building.
Installation Process
Clone the Repository
Initialize your local environment by cloning the official repository:
git clone https://github.com/Gautam25Raj/veriworkly-resume.git
cd veriworkly-resumeConfigure Environment Variables
Environment configuration is required for the site, studio, and server services.
# Duplicate example configuration files
cp .env.example .env
cp apps/server/.env.example apps/server/.env
cp apps/studio/.env.example apps/studio/.env
cp apps/site/.env.example apps/site/.envEnsure the following critical variables are populated:
DATABASE_URL: PostgreSQL connection string.AUTH_SECRET: Security secret for session encryption (must match between server and studio).NEXT_PUBLIC_BACKEND_URL: Typicallyhttp://localhost:8080/api/v1.
Database Initialization
Synchronize your PostgreSQL database with the current Prisma schema:
npm run db:push -w @veriworkly/serverStart Development Servers
The monorepo allows you to run services independently or concurrently.
Option 1: Individual Services
# Terminal 1: Backend API
npm run dev:server
# Terminal 2: Resume Studio
npm run dev:studio
# Terminal 3: Marketing Site
npm run dev:siteOption 2: Concurrent Development
npm run dev:allEnvironment Verification
To confirm a successful installation, verify the following endpoints:
- Marketing Site:
http://localhost:3000 - Resume Studio:
http://localhost:3001 - Documentation:
http://localhost:3002 - Backend API:
http://localhost:8080/api/v1/health(Checks database connectivity)