Skip to content
FaizanmalPublic

About

SyncQuote is a proposal automation platform that transforms static business proposals into interactive, collaborative, and trackable web experiences, helping teams increase engagement, streamline approvals, and close deals faster.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

SyncQuote — Interactive Proposal Platform

Transform static proposals into interactive, collaborative, and trackable web links to help service businesses close deals faster.

Status: Active development / design-partner MVP. Core create → send → public view loop is the priority. Not marketed as production self-serve SaaS yet.

VPS deploy: see VPS_DEPLOY.md — production URL https://syncquote.faizanmalik.me.

License Node.js Version TypeScript

✨ Key Features

🎉 Major Update: 6 powerful new features have been added!

  • 📄 Proposal Templates - Create proposals 70% faster with reusable templates
  • 🔔 Real-Time Notifications - Instant alerts via WebSocket and email
  • 💬 Advanced Collaboration - Threaded comments, @mentions, and resolution tracking
  • 📊 Analytics Dashboard - Track engagement, conversion rates, and performance
  • 📝 Audit Trail System - Complete activity logging for compliance
  • 🎨 White-labeling - Custom branding with logos and colors

🚀 Tech Stack

Backend

  • Primary: NestJS (Node.js + TypeScript) - Main API backend
  • Database: PostgreSQL 16 with Prisma ORM
  • Caching: Redis
  • Authentication: JWT + Google OAuth
  • Payments: Stripe (Billing + Connect)
  • Real-time: Socket.io
  • Email: Resend (SendGrid optional fallback)
  • Storage: AWS S3 / Cloudflare R2
  • Monitoring: Sentry + Pino logging
  • API Docs: Swagger/OpenAPI

Frontend

  • Framework: Next.js 14 (React 19)
  • Styling: Tailwind CSS + shadcn/ui
  • State: TanStack Query
  • Forms: React Hook Form + Zod
  • Editor: Tiptap (Block-based proposal editor)

Infrastructure

  • Backend: AWS ECS Fargate (Docker)
  • Frontend: Vercel
  • Database: AWS RDS PostgreSQL
  • Cache: AWS ElastiCache Redis
  • Storage: AWS S3
  • IaC: Terraform
  • CI/CD: GitHub Actions

📋 Prerequisites

  • Node.js 20+
  • PostgreSQL 16+
  • Redis 7+
  • Docker (for containerization)
  • AWS Account (for production deployment)
  • Terraform (for infrastructure)

🏗️ Project Structure

SyncQuote/
├── backend/                # ARCHIVED — unused Django scaffold (not the product stack)
├── backend-nestjs/         # Primary NestJS backend API
│   ├── src/
│   │   ├── modules/        # Feature modules
│   │   │   ├── auth/       # Authentication & authorization
│   │   │   ├── users/      # User management
│   │   │   ├── proposals/  # Proposal CRUD
│   │   │   ├── comments/   # Comments system
│   │   │   ├── webhooks/   # Stripe webhooks
│   │   │   ├── storage/    # S3/R2 file storage
│   │   │   ├── email/      # Email notifications
│   │   │   ├── events/     # WebSocket events
│   │   │   ├── prisma/     # Database service
│   │   │   └── health/     # Health checks
│   │   ├── app.module.ts
│   │   └── main.ts
│   ├── prisma/
│   │   └── schema.prisma   # Database schema
│   ├── Dockerfile
│   └── package.json
├── frontend/               # Next.js frontend
│   ├── src/
│   │   ├── app/            # App router pages
│   │   ├── components/     # React components
│   │   │   └── ui/         # shadcn/ui components
│   │   ├── hooks/          # Custom React hooks
│   │   ├── lib/            # Utilities
│   │   └── constants/      # Constants & configs
│   ├── public/
│   ├── Dockerfile.dev
│   └── package.json
├── mobile/                 # React Native mobile app
│   ├── src/
│   │   ├── App.tsx
│   │   ├── constants/
│   │   ├── navigation/
│   │   ├── screens/
│   │   ├── services/
│   │   ├── store/
│   │   ├── types/
│   │   └── utils/
│   └── package.json
├── terraform/              # Infrastructure as Code
│   └── main.tf             # AWS resources
├── docker-compose.yml      # Local development setup
└── README.md               # This file

🛠️ Development Setup

Quick Start (Docker)

# Clone and start all services
git clone https://github.com/yourusername/syncquote.git
cd syncquote
docker-compose up -d

# Access:
# - Frontend: http://localhost:3000
# - Backend: http://localhost:3001
# - API Docs: http://localhost:3001/api/docs

Manual Setup

1. Install Dependencies

# Backend
cd backend-nestjs
npm install

# Frontend (in new terminal)
cd ../frontend
npm install

2. Configure Environment Variables

Backend (.env):

DATABASE_URL="postgresql://user:password@localhost:5432/syncquote"
JWT_ACCESS_SECRET=your-secret-key
JWT_REFRESH_SECRET=your-refresh-secret
GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret
STRIPE_SECRET_KEY=sk_test_...
RESEND_API_KEY=re_...
EMAIL_FROM=noreply@faizanmalik.me
AWS_ACCESS_KEY_ID=your-aws-key
AWS_SECRET_ACCESS_KEY=your-aws-secret
S3_BUCKET=syncquote-assets

Frontend (.env.local):

NEXT_PUBLIC_API_URL=http://localhost:3001/api/v1
NEXT_PUBLIC_WS_URL=ws://localhost:3001

3. Database Setup

cd backend-nestjs

# Generate Prisma Client
npx prisma generate

# Run migrations
npx prisma migrate dev

# (Optional) Seed database
npm run seed

# (Optional) Open Prisma Studio
npx prisma studio

4. Start Development Servers

Terminal 1 - Backend:

cd backend-nestjs
npm run start:dev
# API: http://localhost:3001/api/v1
# Docs: http://localhost:3001/api/docs

Terminal 2 - Frontend:

cd frontend
npm run dev
# App: http://localhost:3000

🧪 Testing

Backend

cd backend-nestjs

# Unit tests
npm run test

# E2E tests
npm run test:e2e

# Coverage
npm run test:cov

Frontend

cd frontend

# Run tests (when implemented)
npm run test

📖 Documentation

File Purpose
QUICK_START.md Get started quickly with development setup
ARCHITECTURE.md System architecture and data flows
DEPLOYMENT.md Production deployment guide
README.md This file - project overview

🚢 Deployment

See DEPLOYMENT.md for complete production deployment instructions.

Quick Deploy

# Infrastructure (Terraform)
cd terraform
terraform init
terraform plan -var-file="production.tfvars"
terraform apply -var-file="production.tfvars"

# Backend (GitHub Actions auto-deploys on push to main)
# Frontend (Vercel)
cd frontend
vercel --prod

📚 API Documentation

Once the backend is running, access the Swagger docs at:

🔒 Security Features

  • ✅ HTTPS enforced everywhere
  • ✅ JWT access tokens (15min) + httpOnly refresh tokens (7 days)
  • ✅ Bcrypt password hashing (12 rounds)
  • ✅ Input validation with class-validator
  • ✅ Rate limiting on all endpoints
  • ✅ CORS configured
  • ✅ Helmet security headers
  • ✅ SQL injection protection (Prisma ORM)
  • ✅ XSS protection
  • ✅ CSRF protection via SameSite cookies
  • ✅ Secrets in AWS Secrets Manager
  • ✅ Database connection over SSL

📊 Monitoring & Logging

  • Error Tracking: Sentry (backend & frontend)
  • Logging: Pino → CloudWatch Logs
  • Uptime: UptimeRobot pinging /health
  • Metrics: AWS CloudWatch + ECS Container Insights

🤝 Contributing

This is a private SaaS project. For team members:

  1. Create a feature branch: git checkout -b feature/my-feature
  2. Commit changes: git commit -m 'Add my feature'
  3. Push branch: git push origin feature/my-feature
  4. Open a Pull Request

📄 License

Proprietary - All rights reserved

🆘 Support

For issues or questions:

  • Backend: Check logs in CloudWatch
  • Frontend: Check Vercel deployment logs
  • Database: Check RDS metrics in AWS Console
  • Contact: dev@syncquote.com

About

SyncQuote is a proposal automation platform that transforms static business proposals into interactive, collaborative, and trackable web experiences, helping teams increase engagement, streamline approvals, and close deals faster.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages