https://github.com/adilkadivala/my-uni
Myuni is a Port for student and faculty of University of Macedonia, t was designed to facilitate students' daily interactions with the university.
https://github.com/adilkadivala/my-uni
docker express nginx react typescript
Last synced: 3 months ago
JSON representation
Myuni is a Port for student and faculty of University of Macedonia, t was designed to facilitate students' daily interactions with the university.
- Host: GitHub
- URL: https://github.com/adilkadivala/my-uni
- Owner: adilkadivala
- Created: 2025-07-07T02:23:55.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-07-13T17:11:07.000Z (12 months ago)
- Last Synced: 2025-07-13T17:38:16.650Z (12 months ago)
- Topics: docker, express, nginx, react, typescript
- Language: TypeScript
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎓 MyUni - University Management System
A comprehensive university management system built with React + Vite
---
## 📖 About MyUni
**MyUni** is a modern, feature-rich university management system designed for students and administrators. Built with the latest frontend technologies, it offers intuitive dashboards, real-time updates, and seamless navigation across multiple university modules.
---
## ✨ Features
- 🎯 **Role-Based Access** — Separate dashboards for Students & Admins
- 📅 **Course Scheduling** — Semester plans, subject lists, timings
- 📢 **Announcements System** — Centralized real-time updates
- 🍽️ **Campus Services** — Library, restaurant, map, and utilities
- 👥 **Faculty Directory** — Staff and department listings
- 🌙 **Dark Mode** — Theme toggle using `shadcn/ui`
- 📱 **Fully Responsive** — Tailwind-powered mobile-first design
---
## 🚀 Getting Started
### 📦 Prerequisites
- Node.js v18+
- npm or pnpm or yarn
### 🛠️ Setup
```bash
# 1. Clone the repo
git clone https://github.com/your-username/myuni.git
cd myuni
# 2. Install dependencies
npm install
# 3. Start the dev server
npm run dev
```
Visit: [http://localhost:5173](http://localhost:5173)
---
## 🧪 Default Credentials (For Testing, under development)
### 👨🎓 Student
- Email: `student@myuni.edu`
- Password: `student123`
### 👨💼 Admin
- Email: `admin@myuni.edu`
- Password: `admin123`
---
## 📁 Project Structure (React + Vite)
```txt
myuni/
├── public/ # Static assets
├── src/
│ ├── assets/ # Logos, images, fonts
│ ├── components/ # Reusable components (shadcn/ui + custom)
│ ├── layouts/ # Sidebar layout, theme provider, etc.
│ ├── pages/ # Page components (Dashboard, Services, etc.)
│ ├── routes/ # React Router routes
│ ├── context/ # Auth, Theme, and other contexts
│ ├── hooks/ # Custom hooks
│ ├── lib/ # Utility functions
│ ├── App.tsx # Main entry point
│ └── main.tsx # Vite bootstrap
├── tailwind.config.ts # Tailwind config
├── postcss.config.js # PostCSS config
├── tsconfig.json # TypeScript config
├── index.html # HTML entry
└── vite.config.ts # Vite config
```
---
## 💻 Tech Stack
| Tool | Description |
| ------------------- | ----------------------------------- |
| **React 18** | UI Library |
| **Vite 5+** | Fast build tool and dev server |
| **TypeScript** | Static typing |
| **Tailwind CSS v4** | Utility-first CSS framework |
| **shadcn/ui** | Beautiful component library |
| **Lucide** | Icon set used in UI |
| **React Router** | Routing between student/admin pages |
---
## 🔐 Authentication
- Basic login authentication (username/password)
- Role-based access (admin, student)
- Protected routes (via context or middleware)
---
## 🌙 Theme & Styling
- Theme toggle (light/dark) via `shadcn/ui`
- Typography: `Inter`, imported via Google Fonts
- Fully responsive using Tailwind's mobile-first utilities
---
## 🧑💻 Contributing
```bash
# Create a new feature branch
git checkout -b feature/awesome-feature
# Make your changes, then push:
git push origin feature/awesome-feature
```
Then open a **Pull Request**!
### Guidelines
- Type-safe code (TypeScript)
- Use Tailwind for styling
- Follow component conventions (`shadcn/ui`)
- Keep code readable and modular
---
## 📄 License
This project is licensed under the **MIT License**. See [LICENSE](./LICENSE) for more info.
---
Made with ❤️
© 2025 MyUni. All rights reserved.