Welcome to HostelPro, a full-stack Next.js 15 application designed for modern hostel management. This repository contains a comprehensive solution for both residents and administrators.
This project includes a suite of features to manage a hostel efficiently:
- Public Website: A public-facing site for prospective students to apply, check their application status, and view notices.
- Admin Dashboard: An internal administrative portal for managing students, rooms, applications, complaints, finances, and more.
- Student Portal: A dedicated portal for residents to view their profile, manage payments, file complaints, and access hostel information.
@/components: Reusable React components, including a UI library from Shadcn.@/lib: Shared utilities, type definitions, and mock data.@/models: Mongoose schemas for database models.@/ai: Genkit flows for AI-powered features like complaint categorization.@/app/api: Next.js API routes for backend logic.
- Framework: Next.js 15 (App Router).
- State Management: React Hooks and Context API for client-side state.
- Authentication: Simple token-based authentication for both student and admin portals.
- Database: MongoDB with Mongoose for data modeling.
- Styling: Tailwind CSS with Shadcn UI for a modern, responsive design system.
- AI Integration: Google's Genkit for intelligent features.
To get started with this project, you'll need to have Node.js, npm/yarn/pnpm, and a MongoDB instance available.
From the root of the project, run:
npm installCreate a .env file at the root of the project. You can copy the contents from .env.local.example if it exists, or create it from scratch.
Required variables:
MONGODB_URI: Your MongoDB connection string.RAZORPAY_KEY_ID: Your Razorpay Key ID for payment processing.RAZORPAY_KEY_SECRET: Your Razorpay Key Secret.GEMINI_API_KEY: Your Google AI API key for Genkit features.
To run the application in development mode, execute the following command from the root directory:
npm run devThis will start the development server, typically available at http://localhost:3002.
To build the application for production, run:
npm run buildHostelPro is a full-stack application designed to empower hostel administrators and enhance the resident experience by providing a scalable, maintainable, and high-performance architecture. It combines a public-facing website, a student portal, and an administrative dashboard into a single, cohesive system.
The project includes applications such as a public-facing website, a secure student portal, and a comprehensive admin dashboard, along with shared components and utilities for a streamlined development experience.
The platform is built with a modern technology stack, including Next.js 15, React, TypeScript, Tailwind CSS, Shadcn UI, Mongoose, and Genkit for AI-powered features. This ensures a highly modular and efficient application.
HostelPro
Copyright © 2024. All rights reserved.
This project, HostelPro, is a demonstration of a full-stack hostel management system. Unauthorized use, modification, or distribution of the software or its components is prohibited unless explicitly stated under the terms of the license.
By using or contributing to this project, you agree to comply with the terms and conditions defined in the license. You may use the software for personal or educational purposes, provided that proper credit is given to the original author.
This project is licensed under the MIT License. Please refer to the LICENSE file in this repository for detailed license information. The terms of the license govern the use, distribution, and modification of the software.
The software is provided "as-is" without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
Any trademarks, service marks, or other marks associated with this project or its components are the property of their respective owners.