Quick Start
Choose a development or deployment path and get oriented in the VeriWorkly monorepo.
Quick Start
VeriWorkly is a monorepo containing four Next.js applications, a documentation site, a blog, and one Express/TypeScript API backed by PostgreSQL and Redis.
Implementation paths
Local Development
Recommended for contributors. Run the workspaces manually to modify source code, test features, or design templates.
Docker Deployment
Recommended for self-hosters. Deploy the marketing site, the API, and Redis with the provided Docker Compose configuration and an external PostgreSQL instance.
Project structure
The portfolio templates submodule
apps/portfolio/template-library is a git submodule pointing at a private repository
(VeriWorkly/portfolio-templates). If you do not have SSH access, you can run node scripts/mock-template-library.mjs to generate mock templates and build apps/portfolio locally.
See Portfolio: Templates.
Architectural components
| Component | Workspace | Role |
|---|---|---|
| Marketing site | @veriworkly/site | Landing, pricing, features, roadmap, FAQ, legal, affiliate and ambassador program pages. |
| Studio | @veriworkly/studio | The authenticated workspace: resume and cover letter editors, Master Profile, ATS checker, AI tools, sharing, billing, API keys, admin. |
| Portfolio | @veriworkly/portfolio | The portfolio builder, its public template gallery, and the published portfolio sites. |
| Docs | @veriworkly/docs-platform | This site, built on Fumadocs. |
| Blog | @veriworkly/blog-platform | The official blog, built on Fumadocs. |
| API | @veriworkly/server | Express API for auth, documents, billing, AI, ATS, sharing, portfolios, roadmap, changelog, and admin. |
| Database | PostgreSQL | Primary store, accessed through Prisma. Neon works well for managed deployments. |
| Cache | Redis | Sessions, rate limiting, quotas, buffered view counts, and distributed job locks. |
Next steps
- Local Development Setup — full step-by-step installation.
- Environment Variables — every configuration key.
- Monorepo Architecture — how the workspaces relate to each other.