RentCred is a B2B SaaS platform for tenant verification in Nigeria's rental market. Agents submit tenants for background checks, ops dispatches field agents for property inspections, and verified reports are generated. The platform manages the full lifecycle — submissions, payments, field visits, reports, disputes, and reviews.
# RentCred — Nigeria's Tenant Verification Platform
RentCred is a B2B SaaS platform that enables Nigerian real estate agents to submit tenants for professional background verification. The platform manages the full lifecycle from submission through field inspection, report generation, and post-verification review.
---
## Table of Contents
- Overview
- Quick Start
- Project Structure
- User Roles
- Core Features
- Tech Stack
- Documentation
- Demo Credentials
---
## Overview
### How It Works
```
Agent submits tenant → Ops reviews & assigns field agent
↓ ↓
Credits deducted Field agent conducts site visit
↓
Ops compiles & approves report
↓
Agent receives report → Tenant views report
↓
Tenant leaves review for agent,
landlord, and property
```
### Who Uses It
| User Type | What They Do |
|-----------|-------------|
| **Agent** | Submits tenants, purchases credits, views reports, manages disputes |
| **Ops** | Reviews cases, assigns field agents, approves reports, manages KYB |
| **Field Agent** | Conducts physical property visits, submits visit reports |
| **Tenant** | Completes profile, views their own report, leaves reviews |
| **Admin** | Full system access, audit log, user management |
---
## Quick Start
### Prerequisites
- Node.js >= 20
- PostgreSQL 14+ (running on port 5433 locally)
- Redis 6+
- npm 10+
### 1. Install dependencies
```bash
npm install
```
### 2. Configure environment
```bash
cp apps/api/.env.example apps/api/.env
cp apps/web/.env.example apps/web/.env
```
Edit `apps/api/.env` — at minimum set:
```env
DATABASE_URL="postgresql://rentcred:rentcred@localhost:5433/rentcred?schema=public"
JWT_SECRET="your-secret-minimum-32-characters"
```
### 3. Start infrastructure
```bash
docker-compose up -d # starts PostgreSQL + Redis
```
### 4. Set up database
```bash
npm run db:generate # generate Prisma client
npm run db:migrate:deploy # apply migrations
npm run db:seed # seed demo …