GitHunt
SH

A platform for managing events, attendees, and real-time notifications.

โšก Zenix โ€” Smart Event Platform

Zenix is a real-time event and notification platform built with the MERN stack. It allows users to create and manage events, receive live updates, and communicate instantly. Designed to be scalable, mobile-ready, and developer-friendly, it lays the foundation for future integration with React Native.

๐Ÿ”ง Tech Stack

  • Frontend: React.js, Typescript, Tailwind CSS, MongoDB, Socket.io-client
  • Backend: Node.js, Express.js, MongoDB, Socket.io
  • Auth: JWT with Role-Based Access Control (User, Admin)
  • Dev Tools: ESLint, Prettier, Insomnia, Draw.io
  • License: MIT

๐Ÿ“ Project Structure

zenix/
|
โ”œโ”€โ”€ client/
โ”œโ”€โ”€ server/
โ”œโ”€โ”€ docs/
โ”œโ”€โ”€ screenshots/
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ LICENSE
โ””โ”€โ”€ .gitignore

๐Ÿš€ Getting Started

1. Clone the repository

git clone https://github.com/shawaiz-khan/zenix.git
cd zenix

2. Install dependencies

Backend

cd server
npm install

Frontend

cd ../client
npm install

3. Run the app

Backend (Port 8080)

npm run dev

Frontend (Port 5173)

npm run dev

๐Ÿ“Œ Features

  • ๐Ÿ” JWT-based login and registration
  • ๐Ÿ‘ฅ Role-based access for Admin, Organizer, and Participants
  • ๐Ÿ”” Real-time notifications using Socket.io
  • ๐Ÿ—“๏ธ Event scheduling and management
  • ๐Ÿ’ฌ Event-specific chat with live message updates
  • ๐Ÿ“Š Diagrams for system and database design (in /docs/assets)
  • ๐Ÿ“ฑ Ready for React Native extension

๐Ÿ“„ Documentation

See docs/ for:

  • REPORT.md โ€” full project report
  • MODELS.md โ€” all project model schema
  • API.md โ€” complete documentation for the api
  • ROADMAP.md โ€” roadmap for the project

๐Ÿ“œ License

This project is licensed under the MIT License.

๐Ÿค Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Built with purpose by Shawaiz Khan โค
Future-ready. Real-time. Reliable.