🎬 JIFFY - GIF Messenger

Express yourself better with GIFs! A modern Android messaging app built with Kotlin, Jetpack Compose, Supabase, and a Node.js backend.

📱 Overview

JIFFY is a next-generation GIF-powered messaging application that makes conversations more fun and expressive. Built with modern Android development practices and a scalable Node.js backend deployed on Railway.

✨ Key Features

🔐 Secure Authentication - Google and Apple Sign-In via Supabase Auth
💬 Real-Time Messaging - Instant message delivery using Supabase Realtime
🎨 Dual GIF Sources - Search and share GIFs from both GIPHY and Tenor
👥 Group Chats - Create and manage group conversations (up to 100 members)
📱 Social Sharing - Share GIFs directly to Facebook, Twitter, and Instagram
🔔 Push Notifications - Firebase Cloud Messaging for instant alerts
📊 Analytics - PostHog integration for user insights
🌐 Offline Support - Queue messages when offline, sync when online
🎯 Friend System - Discover, add, and manage friends
⚡ High Performance - Built with Jetpack Compose and optimized backend

🏗️ Architecture

System Overview

┌──────────────────────┐
│   Android App        │
│   (Kotlin/Compose)   │
└──────────┬───────────┘
           │
    ┌──────┴──────┐
    ↓             ↓
┌─────────┐  ┌──────────────┐
│ Backend │  │   Supabase   │
│ Node.js │  │  (Direct)    │
│ Railway │  │  • Realtime  │
│         │  │  • Storage   │
│ • APIs  │  │  • Auth      │
│ • FCM   │  │  • Database  │
└─────────┘  └──────────────┘

Tech Stack

Frontend (Android)

Language: Kotlin 1.9.22
UI: Jetpack Compose + Material 3
Architecture: Clean Architecture (MVVM)
DI: Hilt
Local DB: Room
Image Loading: Coil (GIF support)
Min SDK: 24 | Target SDK: 34

Backend (Node.js)

Runtime: Node.js 18+
Framework: Express.js
Language: JavaScript (ES6+)
Logging: Winston
Caching: node-cache
Testing: Jest
Deployment: Railway (Docker)

Services & APIs

Database: Supabase PostgreSQL
Authentication: Supabase Auth (Google & Apple)
Real-time: Supabase Realtime
Storage: Supabase Storage
Push Notifications: Firebase Cloud Messaging (FCM ONLY)
Analytics: PostHog
GIF APIs: GIPHY SDK + Tenor API
Deployment: Railway

📂 Project Structure

jiffy/
├── app/                    # Android app
│   ├── src/main/
│   │   ├── java/com/darshan/jiffy/
│   │   │   ├── data/
│   │   │   ├── domain/
│   │   │   ├── presentation/
│   │   │   └── di/
│   │   └── res/
│   └── build.gradle.kts
│
├── backend/                # Node.js backend
│   ├── src/
│   │   ├── config/        # Configuration
│   │   ├── controllers/   # Request handlers
│   │   ├── middleware/    # Express middleware
│   │   ├── routes/        # API routes
│   │   ├── services/      # Business logic
│   │   ├── utils/         # Utilities
│   │   └── server.js      # Main server
│   ├── tests/             # Backend tests
│   ├── scripts/           # Deployment scripts
│   ├── Dockerfile
│   ├── railway.json
│   ├── package.json
│   └── README.md          # Backend docs
│
├── database/
│   └── schema.sql         # Supabase PostgreSQL schema
│
├── .github/
│   ├── workflows/
│   │   └── backend-ci.yml # Backend CI/CD
│   └── ISSUE_TEMPLATE/
│
├── README.md              # This file
├── TECH_STACK.md
├── SETUP.md
├── BACKEND_INTEGRATION.md
└── LICENSE

🚀 Getting Started

Prerequisites

For Android Development:

Android Studio Hedgehog (2023.1.1+)
JDK 17+
Android SDK (API 24-34)

For Backend Development:

Node.js 18+
npm 9+

Required Accounts:

Supabase account
Firebase account (FCM)
GIPHY developer account
Google Cloud (Tenor API)
PostHog account
Railway account

Quick Start

Android App

# Clone repository
git clone https://github.com/darshanpania/jiffy.git
cd jiffy

# Configure Android
cp local.properties.example local.properties
# Edit local.properties with API keys

# Build
./gradlew assembleDebug

Backend

# Navigate to backend
cd backend

# Install dependencies
npm install

# Configure environment
cp .env.example .env
# Edit .env with credentials

# Run development server
npm run dev

# Server starts at http://localhost:3000

Full Setup Guide

See SETUP.md for complete setup instructions.

🔗 Backend Integration

When to Use Backend vs Supabase Direct

Use Backend API:

🎨 GIF search (GIPHY/Tenor) - caching + security
🔔 Push notifications (FCM) - token management
📊 Analytics aggregation (future)

Use Supabase Direct:

💬 Real-time messaging - WebSocket efficiency
💾 Database CRUD - RLS security
📁 File uploads - Direct to Storage
🔐 Authentication - OAuth flows

See BACKEND_INTEGRATION.md for details.

📡 API Endpoints

Backend provides RESTful API:

Auth: /api/auth/*
Users: /api/users/*
Chats: /api/chats/*
GIFs: /api/gifs/*
Notifications: /api/notifications/*

Full API documentation: backend/API.md

🗄️ Database

Supabase PostgreSQL (12 Tables):

profiles - User profiles
friendships - Friend relationships
friend_requests - Friend requests
chat_rooms - Chat metadata
chat_participants - Chat membership
messages - All messages
favorite_gifs - Saved GIFs
user_devices - FCM tokens
group_settings - Group config
group_invites - Group invitations
message_reads - Read receipts
chat_notification_preferences - Notification settings

All protected by Row Level Security (RLS)

Schema: database/schema.sql

🚀 Deployment

Android App

Build: ./gradlew assembleRelease
Distribution: Google Play Store
Signing: Configure in app/build.gradle.kts

Backend

Platform: Railway
Method: Docker (Dockerfile)
Deploy: railway up or GitHub push
URL: https://your-app.railway.app

Deployment guide: backend/DEPLOYMENT.md

🧪 Testing

Android Tests

# Unit tests
./gradlew test

# UI tests
./gradlew connectedAndroidTest

Backend Tests

cd backend

# Run tests
npm test

# With coverage
npm test -- --coverage

📚 Documentation

For Developers

README.md - This file
TECH_STACK.md - Complete tech stack
SETUP.md - Detailed setup guide
QUICKSTART.md - Quick start (10 min)
BACKEND_INTEGRATION.md - Backend integration

Backend Specific

backend/README.md - Backend overview
backend/API.md - API documentation
backend/DEPLOYMENT.md - Deployment guide
backend/ARCHITECTURE.md - Architecture
backend/GETTING_STARTED.md - Quick start

Contributing

CONTRIBUTING.md - How to contribute
ROADMAP.md - Development roadmap

🎯 Roadmap

Phase 1: MVP Core (Weeks 1-8) ✅ Planned

Authentication (Google/Apple)
User profiles
Friend system
One-on-one chat
GIF integration (GIPHY + Tenor)

Phase 2: Enhanced Features (Weeks 9-12) ✅ Planned

Group chats (100 members)
Social media sharing
Read receipts
Enhanced notifications

Phase 3: Polish & Release (Weeks 13-16) ✅ Planned

Comprehensive testing
Load testing
Security audit
Beta testing
Production launch

Track progress: Issue #49 - Master Roadmap

🔐 Security & Privacy

Security Features

✅ Supabase Row Level Security (RLS)
✅ JWT authentication
✅ OAuth 2.0 (Google/Apple)
✅ Encrypted token storage
✅ ProGuard/R8 obfuscation
✅ HTTPS only
✅ Backend rate limiting

Privacy

✅ GDPR compliant
✅ No password storage (OAuth only)
✅ PostHog privacy-focused
✅ No message content in analytics
✅ User data control

🤝 Contributing

We welcome contributions! See CONTRIBUTING.md.

# Fork and clone
git clone https://github.com/YOUR_USERNAME/jiffy.git

# Create feature branch
git checkout -b feature/amazing-feature

# Commit changes
git commit -m 'feat: add amazing feature'

# Push and create PR
git push origin feature/amazing-feature

📄 License

MIT License - see LICENSE

👥 Team

Project Lead: Darshan Pania
GitHub: @darshanpania
Email: dev@jiffy.app

🙏 Acknowledgments

Supabase - Backend infrastructure
Railway - Deployment platform
GIPHY - GIF content
Tenor - GIF content
PostHog - Analytics
Firebase - Cloud messaging
Jetpack Compose - UI toolkit

Name		Name	Last commit message	Last commit date
Latest commit History 101 Commits
.github		.github
app		app
backend		backend
database		database
gradle/wrapper		gradle/wrapper
.gitignore		.gitignore
BACKEND_INTEGRATION.md		BACKEND_INTEGRATION.md
BACKEND_ISSUES_SUMMARY.md		BACKEND_ISSUES_SUMMARY.md
BACKEND_SETUP.md		BACKEND_SETUP.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
PROJECT_COMPLETE.md		PROJECT_COMPLETE.md
PROJECT_SUMMARY.md		PROJECT_SUMMARY.md
QUICKSTART.md		QUICKSTART.md
README.md		README.md
ROADMAP.md		ROADMAP.md
SETUP.md		SETUP.md
TECH_STACK.md		TECH_STACK.md
build.gradle.kts		build.gradle.kts
gradle.properties		gradle.properties
local.properties.example		local.properties.example
settings.gradle		settings.gradle
settings.gradle.kts		settings.gradle.kts

Folders and files

Latest commit

History

Repository files navigation

🎬 JIFFY - GIF Messenger

📱 Overview

✨ Key Features

🏗️ Architecture

System Overview

Tech Stack

Frontend (Android)

Backend (Node.js)

Services & APIs

📂 Project Structure

🚀 Getting Started

Prerequisites

Quick Start

Android App

Backend

Full Setup Guide

🔗 Backend Integration

When to Use Backend vs Supabase Direct

📡 API Endpoints

🗄️ Database

🚀 Deployment

Android App

Backend

🧪 Testing

Android Tests

Backend Tests

📚 Documentation

For Developers

Backend Specific

Contributing

🎯 Roadmap

Phase 1: MVP Core (Weeks 1-8) ✅ Planned

Phase 2: Enhanced Features (Weeks 9-12) ✅ Planned

Phase 3: Polish & Release (Weeks 13-16) ✅ Planned

🔐 Security & Privacy

Security Features

Privacy

🤝 Contributing

📄 License

👥 Team

🙏 Acknowledgments

📞 Support

🌟 Quick Links

Android

Backend

Project

About

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages