Development

Welcome to the development section of the addons-server documentation. This guide is designed to help developers quickly understand, set up, and manage the project’s various services. By leveraging Docker Compose, we ensure modularity, isolation, and efficiency across development and testing environments. Here’s a concise overview of each section to get you up and running fast.

• Setup and Configuration
  • Prerequisites
  • Running the docker compose project
  • Shutting down your environment
  • Configuring your environment
  • Gotchas
• Building and Running Services
  • Dockerfile Details
  • Build Process
  • Managing Containers
  • Docker Compose
• Makefile Commands
  • Overview of Makefile
  • Makefile Structure
  • Common Commands
  • Specialized Commands
  • Forcing a Specific Makefile
  • Running Commands Inside the Container
• Testing and Quality Assurance
  • Code Quality and Linting
  • Build Verification
  • Testing
  • E2E Testing
• Data Management
  • Persistent Data Volumes
  • External Mounts
  • Data Initialization
  • Data seeding
  • Data backups
  • Hard Reset Database
• Dependency Management
  • Python Dependencies
  • Pip Dependencies
  • Node.js Dependencies
  • Caching in Docker Build
  • GitHub Actions Cache
  • Updating/Installing Dependencies
• Performance and Optimization
  • Docker Layer Caching
  • Performance Testing
• Localization and Internationalization
  • Locale Management
  • Adding New Translations
  • Translation Management
  • Additional Tools and Practices
  • Translating Fields on Models
• Troubleshooting and Debugging
  • DEV_MODE vs DEBUG
  • Common Issues and Solutions
  • Debugging
  • Additional Debugging Tools
  • Additional Tips
• Github Actions
  • Overview
  • Configuration
  • Gotchas
• Error Pages
• Style Guide
  • Python
  • Markup
  • JavaScript
• Contributing
• Push From Master
  • Local Branches
• Using the VPN with docker on OSX
• Access Control Lists
  • How permissions work
  • Django Admin
• Logging
  • Configuration
  • Using Loggers
• Static Files in addons-server
  • Overview
  • Static File Servers
  • Static File Sources
• How does search on AMO work?
  • High-level overview
  • Technical overview
• Building Docs
• Waffle
  • Why switches and not flags
  • Creating/Deleting a switch
  • Using a switch
  • Testing
  • Enabling your switch
  • Cleanup
• Remote Settings
  • Configure addons-server
  • Set up Remote Settings
  • Configure the user/permissions
• Add-ons Server Documentation
  • Build the documentation