Skip to content

Developer Documentation

This section provides comprehensive documentation for developers working on the CNF Odoo project, including setup guides, upgrade documentation, and technical references.

Getting Started

Environment Setup

Environment Setup Guide - Complete guide for setting up your development environment with both Docker and native source options.

Developer Onboarding

Onboarding Documentation - Essential reading for new developers joining the CNF Odoo project: - Project Overview - Understanding the CNF Odoo ecosystem - Module Upgrade Status - Current state of the 98+ custom modules - Development Workflow - Best practices and procedures

Odoo 18 Upgrade

Upgrade Documentation

18-Upgrade Documentation - Critical information for the ongoing Odoo 18 upgrade project: - Module Removal Guide - Documentation for modules being retired - Dependency Management - Managing the 44 dependency modules

Integration & Connectivity

Odoo Connector

Odoo Connector Documentation - Integration systems and data synchronization: - Catalog Sync - Product catalog synchronization - GrocerKey Integration - Third-party integration docs - PRATS Sync - PRATS system integration

APIs and External Systems

  • CRS API - Customer Relationship System API documentation
  • AWS Processes - Backend API and AWS integration
  • Github Workflow - Development workflow and version control using Github

System Architecture

Job Queue System

Job Queue Documentation - Asynchronous processing and background jobs: - Connector Best Practices - Job Queue Channels

Infrastructure

Website & Frontend

Website Management

Website Documentation - Frontend and website-related guides: - Legacy Website Removal

Development Resources

Technical References

  • Custom Modules Repository: /Users/greg/projects/CNFOdooCustomModules
  • Development Environment: ~/Projects/CommunityNaturalFoods/odoo_dev_env_cnf
  • Module Count: 98+ custom modules being upgraded to Odoo 18
  • Dependencies: 44 modules serve as dependencies for other modules