Skip to content

gabito1451/SkillSync_Server

 
 

Repository files navigation

Mentorship Marketplace

A robust platform built with NestJS that connects experienced professionals (mentors) with individuals (mentees) seeking guidance across technology, business, and digital skills domains.

Mentorship Marketplace Banner

📋 Table of Contents

📝 Overview

Mentorship Marketplace is a platform designed to bridge the gap between knowledge seekers and experienced professionals. By leveraging modern web technologies, we've created an ecosystem where mentees can find, connect with, and learn from mentors specialized in their areas of interest.

The platform facilitates scheduling sessions, managing payments, tracking progress, and fostering long-term professional relationships built on knowledge sharing and growth.

✨ Features

  • Intelligent Mentor Matching

    • Advanced algorithms to match mentees with appropriate mentors based on skills, experience, and goals
    • Search and filter capabilities with customizable parameters
  • Session Management

    • Real-time scheduling with calendar integration
    • Video conferencing capabilities
    • Session history and notes tracking
  • Profile Management

    • Comprehensive mentor profiles with experience validation
    • Skill categorization and expertise levels
    • Portfolio and credential verification
  • Payment Processing

    • Secure payment gateway integration
    • Multiple payment options
    • Automated invoicing and receipts
  • Feedback and Rating System

    • Post-session feedback collection
    • Rating aggregation and display
    • Testimonial management
  • Analytics Dashboard

    • Progress tracking for mentees
    • Performance metrics for mentors
    • Platform usage statistics

🛠️ Technologies Used

💻 Installation

Prerequisites

  • Node.js (v16 or later)
  • npm (v7 or later) or yarn
  • PostgreSQL (v13 or later)

Setup Instructions

  1. Clone the repository:
git clone https://github.com/your-organization/mentorship-marketplace.git
cd mentorship-marketplace
  1. Install dependencies:
npm install
# or using yarn
yarn install
  1. Set up environment variables:
cp .env.example .env
# Edit .env with your configuration details
  1. Set up the database:
npm run migration:run
# or using yarn
yarn migration:run
  1. Start the development server:
npm run start:dev
# or using yarn
yarn start:dev

🚀 Usage

For Mentees

  1. Create an account and complete your profile
  2. Browse available mentors based on your interests
  3. Request mentorship sessions with preferred mentors
  4. Attend sessions, provide feedback, and track your progress

For Mentors

  1. Create an account and build your mentor profile
  2. Set your availability, hourly rates, and expertise areas
  3. Accept mentorship requests
  4. Conduct sessions and provide guidance
  5. Receive payments and feedback

Admin Dashboard

Access the admin dashboard at /admin with appropriate credentials to:

  • Manage users
  • Monitor platform activity
  • Generate reports
  • Configure system settings

📚 API Documentation

Our API follows RESTful principles and uses JWT for authentication.

Base URL

https://api.mentorship-marketplace.com/v1
# or for local development
http://localhost:3000/v1

Authentication

POST /auth/login
POST /auth/register
POST /auth/refresh-token

User Endpoints

GET /users/me
PUT /users/me
GET /users/:id

Mentor Endpoints

GET /mentors
GET /mentors/:id
GET /mentors/:id/availability
POST /mentors/:id/sessions

Session Endpoints

GET /sessions
GET /sessions/:id
PUT /sessions/:id
DELETE /sessions/:id

For complete API documentation, see our Swagger docs when running the development server.

👥 Contributing

We welcome contributions from the community! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch:
    git checkout -b feature/your-feature-name
  3. Commit your changes:
    git commit -m 'Add some feature'
  4. Push to the branch:
    git push origin feature/your-feature-name
  5. Open a pull request

Please read our Contributing Guide for more details.

📄 License

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


Built with ❤️ by the Mentorship Marketplace Team

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 91.8%
  • JavaScript 8.2%