Developer Documentation¶

Welcome, developers! This section contains everything you need to develop, extend, and contribute to the Portugal Odyssey platform.

Quick Start¶

New to the project? Start here: 1. Getting Started Guide - Set up your development environment 2. Architecture Overview - Understand the system design 3. First Contribution - Make your first contribution

Documentation Sections¶

🚀 Getting Started ¶

Local development setup
Environment configuration
First contribution guide

🏗️ Architecture ¶

System overview and design
Microservices architecture
Data flow and messaging patterns

🔌 Services ¶

Individual service documentation
API references
Integration guides

🎨 Frontends ¶

Frontend application guides
Component documentation
UI/UX guidelines

📡 API Documentation ¶

Complete API reference
Authentication and authorization
Endpoint documentation

📖 Guides ¶

Feature-specific guides
Strapi CMS integration
Common workflows

🔧 Troubleshooting ¶

Common issues and solutions
Debugging tips
FAQ

Service Quick Links¶

Service	Documentation	Status
API Gateway	services/api-gateway/	✅
Auth Service	services/auth-service/	✅
Experience Service	services/experience-service/	✅
Payment Service	services/payment-service/	✅
Notification Service	services/notification-service/	✅
File Service	services/file-service/	✅
Review Service	services/review-service/	✅
User Management	services/user-management/	✅

Common Tasks¶

Setting Up Local Development¶

# See getting-started/local-setup.md for details
make dev

Running a Service Locally¶

# See services/[service-name]/development.md
cd services/[service-name]
npm install
npm run dev

Understanding the Architecture¶

Start with Architecture Overview
Review Service Architecture
Check Data Flow

Contributing Code¶

Read First Contribution Guide
Check CONTRIBUTING.md for standards
Review service-specific documentation

Context for AI Agents¶

This section is optimized for AI understanding:

Structure: Organized by development workflow (getting started → architecture → services → guides)
Metadata: Each doc includes audience, category, and related docs
Cross-References: Services link to architecture, APIs link to services
Examples: Code examples and snippets throughout
Terminology: Consistent use of platform-specific terms (see Glossary)

Common queries this section answers: - "How do I set up the development environment?" - "How does service X work?" - "What API endpoints are available?" - "How do I integrate service X with service Y?" - "What's the architecture of the platform?"

Need Help? Check Troubleshooting or ask the team.