Developer Guide
Welcome to the Magnet AI Developer Guide. This section provides comprehensive information for developers who want to extend, customize, or integrate with Magnet AI.
What You'll Find Here
This guide covers:
- Architecture: Understanding the system architecture, backend, frontend, and database design
- API Reference: Complete REST API documentation and authentication guides
- Plugin Development: Creating custom plugins to extend Magnet AI functionality
- Development Setup: Setting up your local development environment, testing, and deployment
Getting Started
If you're new to developing with Magnet AI, we recommend starting with:
- System Architecture - Understand how Magnet AI is structured
- Getting Started - Set up your development environment
- REST API - Learn how to interact with the API
Technical Guides
Detailed guides for specific aspects of development:
- Git Workflow - Branching strategy and release process
- Logging Guide - Using Grafana Loki for logging
- Security Policy - Security practices and vulnerability reporting
- API Structure - Pydantic schemas and entity structure
- External Plugins - Developing and managing external plugins
Contributing
Magnet AI is designed to be extensible and customizable. Whether you're building internal integrations or creating plugins, this guide will help you understand the platform and build effectively.
Need Help?
- Check the Architecture section for system design
- Review API Reference for endpoint documentation
- See Plugin Examples for practical implementations