🌌 Plexus

Plexus is a Club 2.0 platform—a hybrid between a live chat and a social network, powered by a simulated Web3 economy. It features a "cozy" atmosphere with background music, decentralized-inspired identity, and salon-based communities.

🚀 Key Features

💎 Club 2.0 Experience: A cozy digital salon with background music and shared vibes.
🪙 Web3 Economy: Simulated $PLEXUS token. 1 Message = 1 $PLEXUS.
🆔 Identity: Phantom Wallet login and NFT profile pictures.
📱 Mobile Ready: Fully responsive layout with adaptive components.
⚡ Real-time Social: Instant messaging, reactions, and user profiles with social walls.
🚦 Transaction Lifecycle: Simulated blockchain transaction states (Pending, Validated, Failed).

🛠 Tech Stack

Frontend: Vue 3, Pinia, Tailwind CSS, Lucide Icons.
Backend: Node.js, Express, Socket.io.
Database: DuckDB (Fast, analytical, and serverless-friendly).
Automation: Makefile, Husky, Lint-staged, Ruff (Python), ESLint (JS).

📖 Documentation

Explore our detailed documentation in the docs/ directory:

O Vision - Platform vision.
🏗 Architecture - High-level system design.
📂 Structure - Directory and file organization.
⚙️ Functions & API - Socket events and backend logic.
📊 Data Model - Database schema and migrations.
📈 Scalability - Future roadmap and scaling strategies.
📝 Task Tracker - How to use the internal task management tool.

🚦 Quick Start

Prerequisites

Node.js (v18+)
Python 3.10+
Docker (optional, for dev shell)

Installation

make install

Development

# Start the dev environment (Docker)
make dev

# Or run locally
cd server && npm run dev
cd client && npm run dev

🤝 Contributing

We follow a strict development workflow. Please read CONTRIBUTING.md before starting.

Pick a Task: Use make task-list to find something to work on.
Code: Implement your changes.
Verify: Run make lint test to ensure quality.
Commit: Pre-commit hooks will automatically run linting and tests.
Document: Update relevant docs if you add new features.

Built with ❤️ by the Plexus Team.

2.5 KiB Raw Blame History