MentorSync is a comprehensive mentorship platform connecting mentors and mentees for effective learning, guidance, and professional development.

• 🎯 Features
• 🏗️ Architecture
• 🛠️ Tech Stack
• ⚡ Quick Start
• 📚 Documentation
• 🤝 Contributing
• 📝 Versioning

• Mentor-Mentee Matching – Intelligent pairing based on skills, expertise, and interests
• Session Scheduling – Interactive calendar for booking and managing mentorship sessions
• Real-time Messaging – In-app chat for direct communication between mentors and mentees
• Learning Materials – Curated library of resources and guidance documents shared by mentors
• Availability Management – Mentors can set their availability and preferred mentoring hours
• Ratings & Reviews – Transparent feedback system to build trust and quality assurance
• Smart Recommendations – AI-driven suggestions for optimal mentor-mentee pairings

MentorSync follows a Modular Monolith architecture with independent feature modules:

✅ Module Independence – Each module has isolated DbContext, entities, and features

✅ Contracts-Only Dependencies – Modules communicate through .Contracts projects only

✅ Clear Boundaries – Architecture tests validate module isolation

✅ Scalability Path – Modules can be extracted to microservices

✅ CQRS Pattern – Custom command/query handlers for explicit operation flow

• Runtime: .NET 9 with C# 13
• API Framework: ASP.NET Core Minimal APIs
• Architecture: Modular Monolith with CQRS + VSA
• ORM: Entity Framework Core + PostgreSQL (NpSQL)
• Validation: FluentValidation
• Authentication: JWT with refresh tokens
• Service Orchestration: .NET Aspire

• Framework: React 18+ with TypeScript
• Build Tool: Vite
• Styling: TailwindCSS
• State Management: React Context API + Custom Hooks
• HTTP Client: Axios
• Notifications: react-toastify
• Forms: react-hook-form

• Database: PostgreSQL (multi-schema per module)
• Hosting: Azure Container Apps
• IaC: Bicep templates
• CI/CD: GitHub Actions
• Versioning: Semantic Versioning with automated releases

• .NET 9 SDK
• Node.js 20+
• Docker
• Git

1. Clone the repository:

   git clone https://github.com/AndriyBorkovich/mentor-sync.git
   cd mentor-sync

2. Navigate to Aspire host:

   cd aspire/MentorSync.AppHost

3. Run the application:

   dotnet run

   This will start:

   • Backend API (http://localhost:5001)
   • Frontend UI (http://localhost:5173)
   • PostgreSQL database
   • All supporting services

4. Access the application:

   • Frontend: http://localhost:5173
   • API Swagger: http://localhost:5001/swagger
   • Aspire Dashboard: http://localhost:15177

Complete documentation is organized by topic:

• Build Instructions – Detailed setup guide
• Semantic Versioning – Release and version strategy

• Architecture Overview – System design and patterns
• Architecture Testing – Quality assurance approach
• Modular Design – Module structure

• React Components – Frontend best practices
• C# Commands & Queries – Backend patterns
• API Client & Services – HTTP integration
• Error Handling – Exception strategies

• Users Module
• Materials Module
• Scheduling Module
• Ratings Module
• Recommendations Module
• Notifications Module

📖 Browse All Documentation

All commits follow Conventional Commits:

feat: add material recommendations        # MINOR version bump
fix: resolve session timeout              # PATCH version bump
break: migrate to OAuth2                  # MAJOR version bump
docs: update API documentation            # No version change

See Commit Guide for details.

1. Create a feature branch from master

2. Make commits with conventional format

3. Push to GitHub and create a pull request

4. Run tests locally:

   # Backend tests
   dotnet test tests/MentorSync.ArchitectureTests/
   
   # Frontend tests
   cd src/MentorSync.UI && npm test

5. Merge to master when approved

6. Automatic release – Semantic versioning creates release automatically

• Architecture Tests: Validate module boundaries and dependencies
• C# Guidelines: See Coding Standards
• React Guidelines: See Component Standards
• Linting: ESLint + .editorconfig

MentorSync uses Semantic Versioning 2.0.0:

MAJOR.MINOR.PATCH
v1.2.3

• MAJOR: Breaking changes (v1.0.0 → v2.0.0)
• MINOR: New features (v1.0.0 → v1.1.0)
• PATCH: Bug fixes (v1.0.0 → v1.0.1)

Automatic Releases: Versions are calculated from commit messages and released automatically via GitHub Actions.

📋 View Release History

MentorSync/
├── src/
│   ├── Modules/              # Feature modules (Users, Materials, etc.)
│   ├── MentorSync.API/       # API entry point
│   ├── MentorSync.UI/        # React frontend
│   └── MentorSync.SharedKernel/
├── aspire/                   # .NET Aspire orchestration
├── tests/                    # Test projects
├── docs/                     # Comprehensive documentation
├── .github/
│   ├── workflows/            # GitHub Actions (CI/CD, releases)
│   └── git-commit-instructions.md
└── Directory.Build.props     # Global project configuration

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Author: Andrii Borkovych

This project is licensed under the MIT License – see the LICENSE file for details.