ReviewStars Documentation

Complete developer and project documentation for ReviewStars platform

Technical Documentation

For developers who need the project structure, API endpoints, and database schema

Includes:

Project Structure

Complete directory layout

Database Schema

Tables and fields

API Endpoints

All routes documented

Security

Auth, RLS, protection

Complete Feature Guide

Complete explanation of ALL features - what happens, how it works, why it works that way

Includes:

User Features

Signup, browse, accept tasks, write reviews

Admin Features

Dashboard, verification, user management

Data Flow

Complete workflow from request to approval

Scenarios

Common use cases and logic

Perfect for new developers: Learn exactly what each feature does, step-by-step workflows, how data flows through the system, complete examples, and how everything connects together.

Project Overview

What is ReviewStars?

ReviewStars is a fair marketplace platform where Indian businesses can exchange authentic Google reviews.

Help businesses get more reviews
Earn stars by writing reviews
Verified community-driven system
Fair "Stars" currency system

How It Works

For Businesses:

Request reviews → Set reward (2 Stars) → Reviewers complete → Get reviews

For Reviewers:

Browse tasks → Write review → Submit → Earn 1 Star

For Admin:

Verify reviews → Approve payments → Manage disputes

Technology Stack

Frontend

• Next.js 16 (React 19.2)

• TypeScript

• Tailwind CSS 4.1

• Radix UI Components

• SWR Data Fetching

Backend

• Next.js API Routes

• Supabase PostgreSQL

• RPC Functions

• Row-Level Security

• Vercel Blob Storage

Additional

• AI SDK 6.0 (Chat)

• Recharts (Graphs)

• Zod (Validation)

• React Hook Form

• Sonner Toasts

Key Features

1. Review Exchange System

Users request reviews by spending Stars, others complete reviews to earn Stars, Admin verifies transactions.

2. Star Currency

10 free Stars at signup. Spend 2 Stars per request. Earn 1 Star per review. Admin earns 1 Star fee.

3. Verification System

Screenshots uploaded for proof. Admin manually verifies. Only verified reviews trigger payment.

4. Role-Based Access

Users see own data. Admins see all data. Row-Level Security (RLS) ensures data isolation.

5. Automated Workflows

Cron jobs auto-verify eligible reviews. Auto-escalate overdue tasks. Release expired assignments.

6. Admin Dashboard

Real-time analytics. User management. Star distribution. Support ticket system. Broadcast messages.

Database Tables

Table	Purpose	Key Fields
profiles	User accounts & balances	id, email, stars_balance, is_admin
review_requests	Business review requests	id, requester_id, business_name, status
individual_reviews	Review tasks & status	id, assigned_to, status, approval_status
transactions	Star movement history	id, user_id, amount, type, description
support_tickets	User support requests	id, user_id, subject, status
broadcast_messages	System notifications	id, title, content, sent_at

Getting Started as Developer

Clone Repository

git clone <repo-url>

Install Dependencies

npm install

Setup Environment

Copy .env.example to .env.local and add Supabase credentials

Run Development Server

npm run dev - Access at http://localhost:3000

Explore Admin Panel

Go to http://localhost:3000/review4admin (admin login required)

Support & Resources

Email Support

Get help from the support team

support@reviewstars.com

GitHub

View source code and contribute

View Repository

Help Center

Browse FAQs and tutorials

Go to Help

A fair review marketplace built for Indian entrepreneurs.