99 lines (75 loc) · 3.45 KB

SMM Panel Documentation

Welcome to the SMM Panel documentation. This guide will help you get started with development, deployment, and understanding the system architecture.

📚 Documentation Index

Getting Started

Quick Start Guide - Get up and running in 5 minutes
Setup Guide - Detailed installation and configuration instructions
Database Setup - PostgreSQL user creation and database configuration

Development

Structure - Project structure and architecture overview
Design System - UI/UX design patterns and components
Current Status - Development progress and status

Features & Services

Service Category System - Service organization and categorization
SMM Services Catalog - Complete list of available services
Feature Roadmap - Planned features and enhancements

Deployment & Migration

Migration Guide - Database migrations and version upgrades
Morocco Launch Plan - Regional deployment strategy
Restructure Summary - Recent architectural changes

Demo & Testing

Demo Guide - Demo credentials and testing scenarios

🚀 Quick Links

Development Servers

API Server: http://localhost:5000
Web Application: http://localhost:3000
Queue Dashboard: http://localhost:5000/admin/queues
API Health: http://localhost:5000/health

Key Technologies

Backend: Node.js, Express.js, TypeScript
Frontend: Next.js 15, React 19, Tailwind CSS
Database: PostgreSQL with Prisma ORM
Cache/Queue: Redis, Bull
Authentication: JWT with bcrypt

📖 Documentation Standards

All documentation follows these standards:

Written in Markdown
Includes code examples with syntax highlighting
Updated with each major feature release
Reviewed for accuracy during code reviews

🔄 Recent Updates (October 2025)

Security Enhancements

✅ Removed all hardcoded secrets and API keys
✅ Implemented environment variable validation
✅ Added cryptographic API key generation
✅ Created secure database setup guide

New Features

✅ Password reset system with token-based authentication
✅ Newsletter subscription API with email validation
✅ Contact form API with admin management
✅ Mass order frontend integration
✅ Service quality filtering

Code Quality

✅ Fixed all TypeScript compilation errors
✅ Removed unused imports and variables
✅ Clean build with zero warnings

📞 Support

For questions or issues:

Check the relevant documentation section
Review the Feature Roadmap for planned features
Check Current Status for known issues

🔒 Security Notes

Never commit .env files to version control
Use strong, unique passwords for production
Follow the Database Setup Guide for secure configuration
Review environment variables before deployment

📝 Contributing

When adding new documentation:

Place files in the appropriate docs/ subdirectory
Update this index with links
Follow the existing documentation format
Include code examples where applicable

Last Updated: October 29, 2025 Version: 1.0.0 Status: Production Ready