Project documentation (root)
The repository contains many markdown files at the project root and in app folders. This page lists the main ones for quick reference. The canonical documentation is this Docusaurus site (project-docs/); the files below are design notes, setup guides, and troubleshooting.
Setup & deployment
| Document | Description |
|---|
CREATE_DATABASE.md | PostgreSQL database creation and setup |
QUICKSTART.md | Quick start for running the platform |
RENDER_DEPLOYMENT.md | Deploying backend to Render |
VERCEL_QUICK_START.md / VERCEL_*.md | Frontend deployment on Vercel |
TEST_MODE_SETUP.md / TEST_MODE_*.md | Test mode and payment bypass (dev only) |
EMAIL_SETUP_GUIDE.md / RESEND_*.md | Email (Resend) configuration and troubleshooting |
Auth & security
| Document | Description |
|---|
ADMIN_CLI_GUIDE.md | Creating admin users via CLI (create_admin) |
ADMIN_ACCESS_QUICK_START.md | Admin panel access and 2FA |
BACKEND_SECURITY_*.md | Backend security fixes and notes |
MSG91_SETUP.md | Note: SMS/MSG91 is not used; login and sign-up use email OTP only. File kept for possible future SMS enablement. |
Features & design
| Document | Description |
|---|
NOTIFICATIONS_CHECKLIST.md | FCM and in-app notifications checklist |
REFERRAL_CONFIG.md | Referral (refer & earn) configuration |
WALLET_*.md | Wallet system design and security |
COMMISSION_EXPLANATION.md | Platform commission logic |
CORS_AND_APPS_EXPLAINED.md | CORS and app (web/mobile) configuration |
Apps
| Document | Description |
|---|
customer_app/CUSTOMER_APP_ANDROID_REVIEW.md | Android app review and checklist |
customer_app/GOOGLE_MAPS_SETUP.md | Google Maps API key for customer app |
customer_app/PLAY_STORE_*.md | Play Store submission and deep links |
shopkeeper_app/WINDOWS_INSTALLER.md | Windows installer (MSIX, Inno Setup) build |
shopkeeper_app/PRINT_HANG_FIX.md | Printing hang troubleshooting |
Payments & webhooks
| Document | Description |
|---|
WEBHOOK_*.md | Razorpay webhook debugging and fixes |
PAYMENT_*.md | Payment flow, testing, routing |
REFUND_*.md | Refund on withdrawal and policies |
Troubleshooting & operations
| Document | Description |
|---|
TROUBLESHOOTING.md | General troubleshooting |
DEPLOYMENT_CHECKLIST.md | Pre-production checklist |
ENVIRONMENT_VARIABLE_GUIDE.md | Environment variables overview |
For API reference, setup instructions, environment variables, and feature lists, use the Development Guide in this documentation (sidebar). The root docs above are supplementary.