Skip to content

MVP_GUIDE.md

Latest commit

 

History

History
282 lines (225 loc) · 6.58 KB

MVP_GUIDE.md

File metadata and controls

282 lines (225 loc) · 6.58 KB
Raw

Proptify MVP - Setup Guide (npm)

Overview

This branch contains a fully functional MVP with:

  • ✅ Smart Contract: property-token (init, transfer, approve, mint, burn)
  • ✅ Backend API: Express + PostgreSQL + Stellar SDK
  • ✅ Frontend: Next.js 14 with Freighter wallet integration
  • ✅ Database: Properties, users, portfolio tracking
  • ✅ Authentication: SEP-10 wallet signing

Quick Start (5 minutes)

Prerequisites

node --version  # v20+
npm --version   # 10+

# Install Postgres locally
# macOS: brew install postgresql@15
# Ubuntu: sudo apt-get install postgresql
# Windows: https://www.postgresql.org/download/windows/

# Install Soroban CLI
npm install -g soroban-cli

1. Clone & Install

git clone https://github.com/Proptify/proptify.git
cd proptify
git checkout feat/mvp-implementation

# Install all dependencies (npm only)
npm run install-all

2. Set up PostgreSQL Database

# Start PostgreSQL (if not running)
postgres -D /usr/local/var/postgres  # macOS
sudo service postgresql start        # Linux

# Create database and user
psql postgres -c "CREATE USER proptify WITH PASSWORD 'proptify';"
psql postgres -c "CREATE DATABASE proptify OWNER proptify;"

# Verify connection
psql -U proptify -d proptify -c "SELECT NOW();"

3. Configure Backend

cd backend
cp .env.example .env

# Generate Stellar testnet keypair
soroban keys generate admin --network testnet
soroban keys fund admin --network testnet

# Get keys and add to .env
soroban keys show admin --network testnet
# Copy STELLAR_ACCOUNT_ID (public key) and STELLAR_ACCOUNT_SECRET (secret key)

backend/.env:

ADMIN_SECRET_KEY=S...     # From soroban keys show
ADMIN_PUBLIC_KEY=G...     # From soroban keys show
DATABASE_URL=postgresql://proptify:proptify@localhost:5432/proptify
STELLAR_NETWORK=testnet
NODE_ENV=development
PORT=3001

4. Start Backend

# Terminal 1: Backend API
cd backend
npm install
npm run dev

# Should output:
# ✓ Stellar config loaded for testnet
# ✓ Database connected
# 🚀 Server running on http://localhost:3001

5. Start Frontend

# Terminal 2: Frontend
cd frontend
npm install
npm run dev

# Open http://localhost:3000

6. Test Health Check

# Terminal 3: Verify backend
curl http://localhost:3001/health

# Expected response:
# {"status":"ok","network":"testnet","contracts":{...}}

Deploy Smart Contract

Build Contract

cd smartcontract/property-token
cargo build --target wasm32-unknown-unknown --release

Deploy to Testnet

# Deploy
soroban contract deploy \
  --network testnet \
  --source admin \
  --wasm smartcontract/property-token/target/wasm32-unknown-unknown/release/property_token.wasm

# Copy the contract ID (starts with C) and add to backend/.env
CONTRACT_PROPERTY_TOKEN=C...

Initialize Token

soroban contract invoke \
  --network testnet \
  --source admin \
  --id <CONTRACT_ID> \
  -- init \
  --admin <ADMIN_ADDRESS> \
  --name "Lekki Phase 1 Apts" \
  --symbol "LEKKI1" \
  --decimals 8 \
  --total_supply 1000000000 \
  --property_id "prop_1" \
  --location "Lagos, Nigeria" \
  --apy 850

Create Sample Property (via API)

curl -X POST http://localhost:3001/api/properties \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lekki Phase 1 Apartments",
    "location": "Lagos, Nigeria",
    "description": "Modern residential complex with 200 units",
    "property_type": "Residential",
    "total_tokens": 1000000000,
    "price_per_token": 0.50,
    "apy": 8.4,
    "contract_id": "<CONTRACT_ID>"
  }'

Test User Flow

  1. Open frontend → http://localhost:3000
  2. Click "Connect Wallet" → Freighter wallet popup
  3. Sign in → Creates user in database
  4. View properties → http://localhost:3000/properties
  5. See properties → Fetched from PostgreSQL

Project Structure

proptify/
├── backend/
│   ├── src/
│   │   ├── main.ts              # Express entry point
│   │   ├── config/stellar.ts    # Stellar SDK config
│   │   ├── routes/              # API endpoints
│   │   ├── db/db.ts             # PostgreSQL
│   │   └── utils/logger.ts
│   ├── package.json
│   └── .env.example
├── frontend/
│   ├── src/
│   │   ├── app/                 # Next.js pages
│   │   ├── components/          # React components
│   │   ├── hooks/               # Custom hooks
│   │   ├── lib/                 # API clients
│   │   └── types/               # TypeScript types
│   ├── package.json
│   └── tailwind.config.ts
├── smartcontract/
│   ├── property-token/
│   │   ├── src/lib.rs           # Soroban contract
│   │   └── Cargo.toml
│   └── README.md
└── package.json                 # Root npm config

What's Implemented ✅

Smart Contract

  • Token initialization
  • Balance tracking
  • Transfer function
  • Allowance/approve
  • Admin mint/burn
  • Property metadata

Backend

  • Express server with CORS
  • Stellar SDK integration
  • PostgreSQL connection + auto-migrations
  • Health check endpoint
  • Properties CRUD
  • SEP-10 auth challenge/verify
  • User management
  • Portfolio tracking schema

Frontend

  • Next.js 14 setup
  • Freighter wallet integration
  • SEP-10 login flow
  • Property listing page
  • API client hooks
  • Responsive design with Tailwind
  • Header with wallet connect

Common Issues

"Database connection failed"

# Check Postgres is running
psql -U proptify -d proptify -c "SELECT NOW();"

# Restart if needed
sudo service postgresql restart

"Admin keypair not found"

soroban keys generate admin --network testnet
soroban keys fund admin --network testnet
# Copy to backend/.env

"Freighter not detected"

"Port already in use"

# Kill process on port 3001
lsof -ti:3001 | xargs kill -9

# Kill process on port 3000
lsof -ti:3000 | xargs kill -9

Next Steps

  1. Implement token purchase → Wire contract calls to frontend
  2. Add rent distributor contract → Monthly payments
  3. Build portfolio dashboard → User holdings
  4. Add KYC flow → Compliance checks
  5. Deploy to production → Vercel/Heroku

Support