Development Guides
Practical Development Guides Overview
Step-by-step guides for extending the backend, adding models, APIs, permissions, UI pages, and router features.
Practical Development Guides Overview
IMPLEMENTED
These development guides provide copy-pasteable, technically rigorous patterns for extending Sheba ISP ERP without violating architectural invariants.
Guide Directory
- Add a New Django Module: Creating and registering a new app under
backend/apps/. - Add a Database Model & Migration: Creating tenant-scoped models with indexes and safe migrations.
- Add a REST API Endpoint: Serializers, ViewSets, URL routing, and OpenAPI tags.
- Add a System Permission: Registering permission codes and attaching them to roles.
- Add a Frontend Page & UI Component: Creating Next.js App Router pages with forms and data tables.
- Add a Celery Background Task: Async tasks, Redis distributed locks, and error handling.
- Add a MikroTik Operation: Adding RouterOS REST/API commands to
MikroTikService. - Modify an Existing Feature Safely: Testing strategy and verification before committing.