Welcome to Arctyk ITSM Developer Documentation¶
Arctyk ITSM is a modern, Jira-inspired IT Service Management platform built with Django. This documentation is designed for developers, team members, and contributors working on the Arctyk ITSM codebase.
🚀 Quick Start for New Team Members¶
New to the team? Start here:
- Onboarding Guide - Welcome! Get familiar with the team and project
- Development Environment Setup - Set up your local development environment
- Architecture Overview - Understand how Arctyk ITSM is built
- Make Your First Contribution - Submit your first pull request
📖 Documentation Sections¶
Team Onboarding¶
New to the team? Start here to get up to speed.
- Welcome & Overview
- Team Structure & Roles
- Development Environment Setup
- Making Your First Contribution
- Tools & Access
Architecture & Design¶
Understand the system architecture and technical decisions.
- Architecture Overview
- System Design
- Database Schema
- Django App Structure
- Frontend Architecture
- Ticket Workflows
- Authentication & Authorization
- Background Tasks (Celery)
Developer Guide¶
Practical guides for development tasks.
- Developer Guide Overview
- Local Setup
- Docker Development
- Database Migrations
- Testing
- Debugging
- Git Workflow
- Code Review Process
UI Development¶
Frontend templates, styles, and components.
- UI Development Overview
- Django Templates
- Template Partials
- Design System
- SCSS Architecture
- JavaScript Patterns
- UI Patterns
- Branding Guidelines
Components Library¶
Reusable UI components.
Coding Standards¶
Best practices and style guides.
- Standards Overview
- Code Style Guide
- Django Best Practices
- Python Standards (PEP 8)
- Frontend Standards
- Commit Conventions
- Documentation Style
- Security Guidelines
API & Reference¶
Technical reference documentation.
Deployment & Operations¶
Production deployment and operations.
- Deployment Overview
- Environment Configuration
- Production Deployment
- CI/CD Pipeline
- Database Backups
- Monitoring & Logging
- Security Hardening
- Scaling Guide
Changelog & Versioning¶
Release history and migration guides.
🛠️ Technology Stack¶
| Layer | Technology | Version |
|---|---|---|
| Framework | Django | 5.2.9 LTS |
| Language | Python | 3.11+ |
| Database | PostgreSQL | 15+ |
| Cache/Queue | Redis | 7+ |
| Task Queue | Celery | 5.3+ |
| Frontend | Django Templates, SCSS, JavaScript | - |
🔗 Quick Links¶
📚 Recent Updates¶
Check the changelog for the latest features, fixes, and changes.
Latest Version: 0.4.4 (December 26, 2025)
🤝 Contributing¶
We welcome contributions! Here's how to get started:
- Read the contributing guide
- Review the team structure
- Set up your development environment
- Find a good first issue
- Submit a pull request!
📄 License¶
Arctyk ITSM is licensed under the MIT License. See LICENSE for details.
Happy coding! 🚀