Skip to content

surpol/link

Repository files navigation

🔗 Link - Viral Message Spreading Platform

A platform where users can create messages and spread them virally through verified networks. Track who sees your content as it spreads person-to-person.

✨ Features

  • 📝 Message Creation: Write compelling content with titles that spread through networks
  • 🔐 Simple Authentication: Easy @username/password login (no email required)
  • 🌐 Viral Spreading: Messages spread person-to-person through verified handshakes
  • 📊 Real-time Tracking: See exactly who has viewed your message and when
  • 🤝 Verified Networks: Only registered users can view and share messages
  • ⚡ Bot-Friendly: Easy signup process allows organic and bot participation

🚀 Getting Started

Prerequisites

  • Node.js (20+ recommended)
  • MongoDB (local or cloud instance)

Installation

  1. Clone and install:
npm install --force
  1. Set up MongoDB (optional - defaults to localhost):
# Contact me for the .env file
echo "MONGO_URI=mongodb://localhost:27017/link-app" > .env
echo "PORT=3001" >> .env
  1. Start the servers:
npm run dev
  1. Visit the app:
    • Frontend: http://localhost:5173 (or port shown in terminal)
    • API: http://localhost:3001

📖 How It Works

1. Landing Page

  • Marketing page explaining viral message spreading
  • Clear call-to-action to join the platform

2. Simple Signup/Login

  • Just @username and password (no email required)
  • Designed to be bot-friendly for organic growth
  • Instant account creation

3. Message Creation (Coming Soon)

  • Create titled messages with rich content
  • Set initial sharing targets
  • Track viral spread analytics

4. Viral Sharing (Coming Soon)

  • Share messages with specific @usernames
  • Handshake verification system
  • Recipients can then share with their networks

🔧 API Endpoints

  • POST /api/auth/signup - Create new account
  • POST /api/auth/login - User login
  • GET /api/users/:username - Get user profile
  • GET /api/health - Health check

🗃️ Database Structure

MongoDB Collections:

  • users - User accounts with hashed passwords
  • messages - Created content (coming soon)
  • shares - Viral spread tracking (coming soon)

🎯 Current Status

Completed:

  • Landing page with viral messaging marketing
  • Simple @username/password authentication
  • User registration and login
  • Basic dashboard structure
  • MongoDB integration with password hashing

🚧 Coming Next:

  • Message creation and management
  • Viral sharing system with handshakes
  • Real-time spread tracking and analytics
  • User profiles and message history

🤖 Bot-Friendly Design

The platform is intentionally designed to allow easy bot participation:

  • No email verification required
  • Simple username/password signup
  • API-first architecture
  • Programmatic account creation supported

📱 Tech Stack

  • Frontend: Svelte 5 + SvelteKit + TypeScript
  • Backend: Express.js + TypeScript
  • Database: MongoDB with indexes
  • Auth: bcrypt password hashing
  • Styling: Custom CSS with CSS variables

🚀 Deployment Ready

The app is designed for easy deployment:

  • Environment variable configuration
  • Graceful MongoDB connection handling
  • Production-ready build scripts
  • Health check endpoints

Ready to spread your message? Visit the landing page and join Link today!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors