yurixander / mirage

💫 A simple, lightweight, and easy-to-use web client for the [Matrix] protocol.

A simple, lightweight, and easy-to-use web client for the [Matrix] protocol.

🎯 Goal: Create a seamless and intuitive web-based client for the [Matrix] protocol, that is feature-complete and customizable.

Features

• 📐 Simple & consistent UI: Maintain a clean interface that is consistent in its design, and emphasizes simplicity.
  
  
• ⚡ Feature-complete: Make all the features that the Matrix protocol has to offer, available to the user, whilst not polluting the UI or overwhelming the user. (Work in progress)
  
  
• ⚡ Animations: The use of animations (where appropriate) provides deeper feedback to user engagement with the UI (Work in progress)
  
  
• ✨ Themes & customization: Empower the user to customize the UI to their liking (including fonts and colors), enabling the creation of themes for a more personalized experience. (Work in progress)
  
  

Building and running

Prerequisites

• Node.js
• Yarn (optional)

Building & running locally

npm install
npm run dev

Technology Stack

• Programming language:
  • TypeScript
• User-interface:
  • React
  • SCSS/SASS
  • Tippy.js: Tooltip library for React
• Additional tooling & frameworks:
  • Matrix JS SDK: Matrix client library
  • Vite.js: Build tooling
  • Boring Avatars: Avatar generator
  • DayJS: Date & time formatting library
  • Zustand: React state-management library
  • Storybook.js: Isolated component development environment

---