Skip to main content

Getting Started with Onwards Monorepo

Welcome! This is your starting point for understanding and working with the Onwards codebase.

Choose Your Path​

👨‍💻 I'm a Developer​

→ Developer Onboarding

  • Set up your development environment
  • Understand the codebase structure
  • Learn key patterns and practices

📊 I'm on the Product Team​

→ Product Team Guide

  • Learn about features and capabilities
  • Understand how things work (non-technical)
  • Find user-facing documentation

🏗️ I Want to Understand the Architecture​

→ Codebase Overview

  • High-level system architecture
  • Technology stack
  • Key design decisions

Quick Navigation​

By What You Want to Do​

I want to...Go to...
Learn about a featureFeatures
Implement something newDevelopment Guides
Look up an APIAPI Reference
Understand system designArchitecture
Deploy or configureDeployment

By Your Role​

Developers:

Product Managers:

DevOps/SRE:

Documentation Structure​

docs/
├── getting-started/     ← You are here!
├── features/            User-facing features
├── development/         Developer how-to guides
├── api-reference/       API endpoints and schemas
├── architecture/        System architecture and ADRs
└── deployment/          Deployment and configuration

Common Questions​

"Where do I start as a new developer?"​

  1. Read Developer Onboarding
  2. Review Codebase Overview
  3. Browse Development Guides

"How do I find documentation on a specific topic?"​

  • Use the search box (top right)
  • Browse by category in the sidebar
  • Check the Codebase Overview

"I want to understand a feature"​

Key Technologies​

  • Backend: Node.js, TypeScript, tRPC
  • Database: PostgreSQL with Prisma ORM
  • Job Queue: BullMQ with Redis
  • Frontend: Angular
  • Infrastructure: AWS (S3, RDS)

Getting Help​

For Code Questions​

  • Use Claude to explore the codebase
  • Ask: "Where is X implemented?"
  • Ask: "How does Y work?"

For Documentation Questions​

  • Check this documentation site
  • Look in the appropriate section
  • Review architecture docs for design decisions

What's Next?​

Choose your path above, or jump directly to:

Welcome to the team! 🎉