🌌 Plexus

Plexus is a premium, decentralized-inspired chat application built with Vue 3, Node.js, Socket.io, and DuckDB. It features a sleek Discord-style interface, real-time messaging, and social profiles with customizable "walls".

🚀 Key Features

• 💎 Premium UI: Discord-inspired dark theme with glassmorphism and smooth animations.
• 📱 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) with LED indicators.
• 🛠 Robust Tooling: Automated linting, testing, and a custom internal task tracker.

🛠 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:

• 🏗 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.

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

---

Built with ❤️ by the Plexus Team.