chitfund/README/QUICK_START.md

1.5 KiB

Quick Start Guide

Get LuckyChit running in 5 minutes.


🚀 Backend (2 minutes)

cd backend

# 1. Install dependencies
npm install

# 2. Setup environment
cp env.example .env
nano .env  # Add your database credentials

# 3. Create database (if needed)
sudo -u postgres psql
postgres=# CREATE DATABASE luckychit;
postgres=# \q

# 4. Run migration
node run-member-number-migration.js

# 5. Start server
pm2 start ecosystem.config.js
# or
npm start

Backend running at http://localhost:3000


📱 Frontend (2 minutes)

cd luckychit

# 1. Install dependencies
flutter pub get

# 2. Update API URL (if needed)
# Edit: lib/core/services/api_service.dart
# Change baseURL to your backend URL

# 3. Run app
flutter run
# or build APK
flutter build apk --release

App running!


Verify Everything Works

Test Backend

# Health check
curl http://localhost:3000/health

# Should return: {"success":true, "message":"..."}

Test App

  1. Open app
  2. Signup as manager
  3. Create a test group
  4. Add members (see member numbers #1, #2, #3)
  5. Edit member details
  6. Everything should work!

🎯 Default Credentials

Test Manager:

  • Mobile: 9876543210
  • Password: password123

Test Member:

  • Mobile: 9876543211
  • Password: password123

🆘 Having Issues?

See TROUBLESHOOTING.md or backend/TROUBLESHOOTING.md


Next: Read ADMIN_GUIDE.md to learn all the admin features!