​

AdminWeb Project Wiki

​

📚 Repository Structure

Wiki/
├── index.mdx (you are here)
├── llms.txt
├── architecture/           # System design and infrastructure
│   └── system-overview.md
├── features/               # Feature documentation
├── guides/                 # How-to guides (setup, deployment, etc.)
├── database/               # Database schema and data model
├── operations/             # Operations and monitoring
├── security/               # Security guidelines and best practices
└── staging/                # Staging and testing documentation

​

🧭 Quick Navigation

​

🚀 Key Concepts

​

Microservices Architecture

• Web Applications (*.Web): Blazor frontends for end users
• Service APIs (*.ServiceApis): Backend business logic
• Background Workers (*.Workers): Scheduled jobs and message processing
• Core Libraries (*.CoreLibs): Shared data models and database access

​

Infrastructure Components

• Aspire (Main.AppHost): Local development orchestration
• Yarpie: Production reverse proxy with blue/green deployments
• MSSQL: Database
• RabbitMQ: Message broker for async communication

​

📖 How to Navigate

​

By Role

1. Read System Architecture
2. Pick a service that interests you
3. Check our guides section
4. Review code standards

1. Start with shared components documentation
2. Understand Identity & Auth
3. See local setup guide

1. Read System Architecture
2. Check deployment guides
3. Review operations procedures

​

By Question

​

🔄 Important Concepts

​

Service-to-Service Communication

​

Data Access

• Entity Framework: First choice for data access
• Dapper: For complex queries only

​

✍️ Contributing to the Wiki

​

How to Add or Update Documentation

1. Clone/Fork this repository
   Copy

   Ask AI

   git clone https://github.com/SportAdminOrganization/Wiki.git
   
2. Navigate to the appropriate folder based on what you’re documenting
3. Create or edit a .md file following the naming conventions:
   • Use lowercase with hyphens: my-topic.md
   • Use clear, descriptive titles
4. Follow the documentation template:
   Copy

   Ask AI

   ---
   project_type: "ServiceApi"
   primary_tech: "GRPC, Aspire"
   related_projects: ["Project1", "Project2"]
   ---
   
   > **Summary:** Brief description of the topic
   
   ## Overview
   Main content here...
   
5. Include diagrams using Mermaid when helpful
6. Link to related docs: Use relative links
7. Submit a Pull Request with a clear title and description

​

📋 Documentation Standards

• Use clear, concise language
• Include code examples where applicable
• Have a brief summary at the top (in blockquote)
• Include YAML frontmatter with project type and related projects
• Use relative links for cross-references
• Include Mermaid diagrams for complex flows

​

🔗 Links

• Main Repository: AdminWeb on GitHub
• Issue Tracker: GitHub Issues
• Discussions: GitHub Discussions

​

❓ FAQ