Yaltopia-Ticket-Admin/dev-docs

Developer Documentation

Essential documentation for the Yaltopia Ticket Admin project.

📚 Documentation

Development Guide

Complete development guide including:

• Tech stack & project structure
• Quick start & setup
• Common tasks & best practices
• Troubleshooting

API & Service Layer Guide ⭐

Essential reading for making API calls:

• Service layer architecture
• All available services & methods
• Common patterns & examples
• Error handling
• Best practices

Testing Guide

Testing setup and practices:

• Unit testing with Vitest
• Component testing
• Integration testing
• Test utilities & mocks

Deployment Guide

Production deployment:

• Pre-deployment checklist
• Deployment options (Docker, VPS)
• Environment configuration
• CI/CD setup

Security Guide

Security best practices:

• Authentication & authorization
• Data protection
• Security headers
• CORS configuration
• Input validation

🚀 Quick Start

# Install
npm install

# Configure
cp .env.example .env
# Edit .env with your backend URL

# Develop
npm run dev

# Test
npm run test

# Build
npm run build

📖 Key Concepts

Service Layer

All API calls go through typed service classes:

import { userService } from '@/services'
const users = await userService.getUsers()

React Query

Data fetching with caching:

const { data } = useQuery({
  queryKey: ['users'],
  queryFn: () => userService.getUsers()
})

Protected Routes

Authentication required for admin routes:

<Route element={<ProtectedRoute />}>
  <Route path="/admin/*" element={<AdminLayout />} />
</Route>

🆘 Need Help?

1. Making API calls? → API & Service Layer Guide
2. General development? → Development Guide
3. Writing tests? → Testing Guide
4. Deploying? → Deployment Guide
5. Security questions? → Security Guide

---

Last Updated: 2024
Maintained By: Development Team