Skip to main content
Mirage Hero Light

​
What is Mirage?

Mirage is a dynamic social platform that combines the best of social networking and real-time communication. Share your thoughts through posts, connect with like-minded people, and engage in meaningful conversations through both public and private chat rooms.

Quickstart

Create your account and start your first conversation in minutes

Installation

Set up Mirage locally or deploy to production

API Reference

Complete REST API documentation for developers

GitHub

View source code and contribute on GitHub

​
Core Features

Social Posts

Share thoughts up to 512 characters with voting and threaded replies

Chat Rooms

Create public or private rooms for group conversations

Direct Messages

Send private messages directly to any user

Follow System

Build your network by following users you find interesting

For You Page

Personalized feed with trending topics and content from followed users

File Sharing

Share files up to 24MB in chat rooms

​
Platform Highlights

​
Personalized Discovery

The For You Page (FYP) uses an intelligent algorithm that blends:
  • 40% recent posts from people you follow
  • 40% fresh content from the global community
  • 20% archive posts to help you discover hidden gems
With trending hashtags calculated in real-time, you’ll always know what’s capturing the community’s attention.

​
Flexible Communication

Join any of the platform’s public chat rooms (max 5) to connect with the broader community. Perfect for topic-based discussions, events, or casual conversations.
Create password-protected rooms for intimate group conversations. Ideal for teams, friend groups, or exclusive communities.
Send one-on-one messages that appear in your recipient’s inbox. All messages persist until manually deleted.

​
Smart Content Management

Room messages are automatically cleaned up after 30 minutes, keeping conversations fresh and relevant. Only the most recent 100 messages are stored at any time.

​
Rich User Profiles

Every user profile displays comprehensive stats:
  • Follower and following counts
  • Total posts (including replies)
  • Cumulative upvotes and downvotes
  • Custom avatars and descriptions (up to 500 words)
  • Personalized CSS and background images

​
Authentication & Security

Mirage uses token-based authentication with secure password hashing: 
{
  "token": "uuid-v4-token",
  "username": "your_username"
}
All protected endpoints require an Authorization header containing your unique session token.
Tokens are invalidated on logout. Keep your token secure and never share it publicly.

​
Content Limits

Content TypeLimit
Post/Reply Content512 characters
User Description500 words
File Uploads24 MB
Public Rooms5 total
Room Messages100 max, 30-minute expiry

​
Getting Started

1

Create Your Account

Sign up with a username, email, and password. Optionally add an avatar URL and description.
2

Explore the For You Page

Discover trending content and find users to follow.
3

Join or Create a Room

Browse public rooms or create your own private space.
4

Start Posting

Share your first post and engage with the community through votes and replies.

Ready to get started?

Follow our quickstart guide to create your account and post your first message

​
Community Standards

  • Be Authentic: Your voice matters. Share genuine thoughts and experiences.
  • Vote Fairly: You can’t vote on your own posts, ensuring honest engagement.
  • Respect Limits: Content restrictions keep conversations focused and meaningful.
  • Engage Thoughtfully: Replies and direct messages help build real connections.

​
Next Steps

Quickstart Guide

Create your account and send your first message

Installation Guide

Deploy Mirage for your community

Build docs developers (and LLMs) love

Get started for freeTalk to us