Skip to main content

Welcome to Duit Documentation

A comprehensive platform connecting clients with service professionals. Find professionals, manage job requests, and build your reputation through ratings and reviews.

Get StartedExplore Features
Duit Platform

Quick start

Get Duit up and running in minutes with these simple steps

1

Clone the repository

Start by cloning the Duit repository to your local machine:
git clone https://github.com/FerCueA/Duit.git
cd Duit
2

Configure your database

Create a .env file in the project root with your PostgreSQL credentials:
DB_URL=jdbc:postgresql://localhost:5432/duit
DB_USER=your_username
DB_PASS=your_password
Make sure PostgreSQL is installed and running on your system before proceeding.
3

Run the application

Launch the Spring Boot application using Maven:
# On Linux/Mac
./mvnw spring-boot:run

# On Windows
mvnw.cmd spring-boot:run
The application will be available at http://localhost:8080
4

Create your first account

Navigate to the registration page and create an account as either a client or professional:
  • Client: Search for professionals and create service requests
  • Professional: Create a profile, set your rates, and respond to job opportunities
Choose the “Professional” account type if you plan to offer services. You can always create additional accounts for testing.

Explore by topic

Jump into detailed guides based on your role and needs

For Clients

Learn how to find professionals, create service requests, and manage your jobs

For Professionals

Set up your professional profile, manage applications, and build your reputation

For Administrators

Manage service categories, oversee users, and access platform analytics

Key features

Discover what makes Duit powerful for connecting clients and professionals

Role-based Access Control

Secure authentication with Spring Security and role-specific permissions for clients, professionals, and admins

Professional Profiles

Detailed profiles with category specializations, hourly rates, and NIF validation

Job Application Workflow

Complete lifecycle from service request creation to professional application and job completion

Rating System

Build trust through ratings and reviews that showcase professional reputation

Location-based Matching

Find professionals by service category and location with address handling

Admin Dashboard

Centralized management for categories, users, and platform oversight

Technical resources

Dive into the architecture and development details

Architecture Overview

Understand the Spring Boot architecture and technology stack

Database Schema

Explore the PostgreSQL database structure and entity relationships

API Endpoints

Reference for all HTTP endpoints and controller routes

Contributing Guide

Learn how to contribute to the Duit project

Ready to get started?

Set up your local development environment and start exploring the Duit platform

Install Duit