Skip to main content

Getting Started

Welcome to ThePlugg Developer Documentation! This guide will help you understand and work with the ThePlugg platform.

Overview

ThePlugg is a service marketplace platform connecting service providers with service seekers. The platform consists of three main components:

  1. Backend API - Node.js/Express backend with Prisma ORM
  2. Mobile App - Flutter app for iOS and Android
  3. Admin Dashboard - React.js admin interface

Prerequisites

Before getting started, ensure you have:

  • Node.js 18+ installed
  • PostgreSQL database
  • Flutter SDK (for mobile app development)
  • Git

Project Structure

ThePlugg/
├── ThePlugg-backend/ # Node.js/Express API
├── ThePlugg-app/ # Flutter mobile app
├── theplugg-admin/ # React admin dashboard
└── ThePlugg-docs/ # This documentation site

Getting Help

If you need assistance:

  1. Check the relevant documentation section
  2. Review the API endpoints documentation
  3. Check the codebase for examples

Next Steps