Skip to content

A NestJS-based REST API for a platform that connects service providers with customers.

Notifications You must be signed in to change notification settings

muhammedfurkan/service-platform-api

Repository files navigation

Service Platform API

A NestJS-based REST API for a platform that connects service providers with customers.

Turkish Version (Türkçe)

Features

  • 🔐 JWT-based authentication
  • 👥 Customer and service provider roles
  • 📑 Category management
  • 🛠️ Service management
  • 📅 Reservation system
  • 💳 Payment system
  • ⭐ Ratings and reviews
  • 📨 Multiple notification channels (Email, SMS, Push, WebSocket)
  • 📍 Location-based service search
  • 📱 Real-time notifications with WebSocket support

Technologies

  • NestJS
  • MongoDB & Mongoose
  • Socket.IO
  • JWT Authentication
  • Swagger API Documentation
  • NodeMailer
  • Firebase Admin (Push Notifications)
  • Twilio (SMS)

Getting Started

Prerequisites

  • Node.js (v14+)
  • MongoDB
  • npm or yarn

Installation

  1. Clone the project
git clone https://github.com/your-username/service-platform-api.git
cd service-platform-api
npm install
  1. Set environment variables
PORT=3000
MONGODB_URI=mongodb://localhost:27017/service-platform
JWT_SECRET=your-secret-key
JWT_EXPIRES_IN=7d

SMTP_HOST=smtp.gmail.com
SMTP_PORT=465
  
[email protected]
SMTP_PASS=your-app-password
[email protected]
  1. Start the application
# Development
npm run start:dev

# Production
npm run build
npm run start:prod
  1. API Documentation
http://localhost:3000/api

Contributing

  1. Fork this repository
  2. Create a new branch (git checkout -b feature/feature-name)
  3. Make changes
  4. Commit your changes (git commit -am 'Add new feature')
  5. Push to your branch (git push origin feature/feature-name)
  6. Create a new Pull Request

License

Distributed under the MIT License. See LICENSE for more information.


Service Platform API - TR (Türkçe)

Bu proje, hizmet sağlayıcıları ile müşterileri buluşturan bir platform için geliştirilmiş NestJS tabanlı bir REST API'dir.

Özellikler

  • 🔐 JWT tabanlı kimlik doğrulama
  • 👥 Müşteri ve hizmet sağlayıcı rolleri
  • 📑 Kategori yönetimi
  • 🛠️ Hizmet yönetimi
  • 📅 Rezervasyon sistemi
  • 💳 Ödeme sistemi
  • ⭐ Değerlendirme ve yorumlar
  • 📨 Çoklu bildirim kanalları (Email, SMS, Push, WebSocket)
  • 📍 Konum bazlı hizmet araması
  • 📱 WebSocket desteği ile gerçek zamanlı bildirimler

Teknolojiler

  • NestJS
  • MongoDB & Mongoose
  • Socket.IO
  • JWT Authentication
  • Swagger API Documentation
  • NodeMailer
  • Firebase Admin (Push Notifications)
  • Twilio (SMS)

Başlangıç

Ön Gereksinimler

  • Node.js (v14+)
  • MongoDB
  • npm veya yarn

Kurulum

  1. Projeyi klonlayın
git clone https://github.com/your-username/service-platform-api.git
cd service-platform-api
npm install
  1. Ortam değişkenlerini ayarlayın
PORT=3000
MONGODB_URI=mongodb://localhost:27017/service-platform
JWT_SECRET=your-secret-key
JWT_EXPIRES_IN=7d

SMTP_HOST=smtp.gmail.com
SMTP_PORT=465
[email protected]
SMTP_PASS=your-app-password
[email protected]
  1. Uygulamayı başlatın
# Geliştirme
npm run start:dev

# Prodüksiyon
npm run build
npm run start:prod
  1. API Dokümantasyonu
http://localhost:3000/api

Katkıda Bulunma

  1. Bu depoyu forklayın
  2. Yeni bir dal oluşturun (git checkout -b feature/feature-name)
  3. Değişikliklerinizi yapın
  4. Değişikliklerinizi commit edin (git commit -am 'Add new feature')
  5. Dalınıza push yapın (git push origin feature/feature-name)
  6. Bir pull request açın

Lisans

Distributed under the MIT License. See LICENSE for more information.

About

A NestJS-based REST API for a platform that connects service providers with customers.

Topics

Resources

Stars

Watchers

Forks