Remind Me - Admin Panel
A React-based administrative interface for managing class schedules and holidays.
š Features
Schedule Management
- Create and manage class schedules
- Upload PDF to extract schedules
- Add/Edit/Delete class timings
- Instructor management
- Section and semester organization
Holiday Management
- Manage academic holidays
- Holiday calendar integration
š ļø Tech Stack
- Frontend Framework: React 18.3
- Build Tool: Vite 5.4
- UI Components:
- Radix UI
- Shadcn UI
- React Select
- Tailwind CSS 4.1
- Routing: React Router DOM 6.26
- Notifications: React Toastify
- Analytics: Vercel Analytics
š¦ Installation
Clone the repository:
git clone https://github.com/the-remind-me/remind-me-v4-adminpanel.git
Install dependencies:
npm install
Start the development server:
npm run dev
š§ Configuration
The project uses several configuration files:
- vite.config.js - Vite configuration
- tailwind.config.js - Tailwind CSS configuration
- components.json - UI components configuration
- jsconfig.json - JavaScript configuration and path aliases
š Project Structure
src/
āāā assets/ # Static assets
āāā components/ # Reusable components
ā āāā ui/ # UI components
ā āāā ... # Other components
āāā lib/ # Utility functions
āāā pages/ # Page components
āāā main.jsx # Application entry point
š Available Scripts
- npm run dev - Start development server
- npm run build - Build for production
- npm run lint - Run ESLint
- npm run preview - Preview production build
š Environment Variables
Create a .env file in the root directory with the following variables:
VITE_API_URL="BACKEND_URL_HERE"
š License
MIT License
š„ Contributors
Biplab Roy -> Profile
š¤ Contributing
- Fork the repository
- Create your feature branch ( git checkout -b feature )
- Commit your changes ( git commit -m 'Add some AmazingFeature' )
- Push to the branch ( git push origin feature )
- Open a Pull Request
Thank You
The Remind Me Team