Skip to content

mickey4653/pingchain

Repository files navigation

PingChain - Smart Communication Assistant

PingChain helps you maintain meaningful connections by reminding you to follow up, suggesting thoughtful responses, and tracking your communication patterns.

Never leave important conversations hanging.

Features

  • Smart reminders for follow-ups
  • AI-powered message drafting
  • Communication pattern insights
  • Social authentication
  • Responsive design for web and mobile

Getting Started

Prerequisites

  • Node.js 18+ and npm
  • GitHub account (for OAuth)
  • Google account (for OAuth)
  • OpenAI API key (for AI features)

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/pingchain.git
cd pingchain
  1. Install dependencies:
npm install
  1. Create a .env.local file in the root directory with the following variables:
# NextAuth.js
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=your-secret-key-here # Generate a secure secret key

# GitHub OAuth
GITHUB_ID=your-github-client-id
GITHUB_SECRET=your-github-client-secret

# Google OAuth
GOOGLE_ID=your-google-client-id
GOOGLE_SECRET=your-google-client-secret

# OpenAI (for AI features)
OPENAI_API_KEY=your-openai-api-key
  1. Set up OAuth applications:

  2. Run the development server:

npm run dev
  1. Open http://localhost:3000 in your browser.

Development

Project Structure

pingchain/
├── src/
│   ├── app/              # Next.js app directory
│   ├── components/       # React components
│   ├── lib/             # Utility functions
│   └── types/           # TypeScript types
├── public/              # Static assets
└── prisma/             # Database schema

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run start - Start production server
  • npm run lint - Run ESLint

Core Features

Loop Dashboard

  • Open Loops: Track conversations that need follow-up
  • Pending Replies: Monitor messages that need responses
  • Streaks: Track your communication consistency
  • Check-Ins Sent: Count of AI-assisted messages sent

Smart Reminders

  • Automated detection of conversations that need attention
  • AI-generated response suggestions
  • Priority-based urgency indicators

Communication Contracts

  • Set up regular check-in schedules
  • Define response time expectations
  • Track communication commitments

AI Message Assistant

  • Tone analysis and suggestions
  • Context-aware message drafting
  • Relationship-focused communication guidance

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A universal communication assistant app that helps people follow through, stay emotionally connected, and avoid communication drop-offs — using AI, reminders, emotional intelligence, and smart nudges.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages