The frontend is built using React, Tailwind CSS, React Context API, and React Router. It provides the user interface for students, wardens, security, and administrators to interact with the hostel management system.
- Framework/Library: React.js
- Styling: Tailwind CSS
- State Management: React Context API
- Routing: React Router
- API Communication: Fetch API
- Build Tool: Vite
- Clone the repository:
git clone https://github.com/thisisdkyadav/hostel-management-system-frontend - Navigate to the frontend directory:
cd hostel-management-system-frontend - Install dependencies:
npm i - Run the development server:
npm run dev
Detailed technical documentation for the frontend codebase can be found in the docs/ directory. This documentation mirrors the structure of the /src directory.
- Source Code Documentation (
/docs/src): Detailed documentation for components, contexts, pages, services, hooks, and utilities.
Use the links within the documentation files (.md and README.md) located inside the docs/ directory to navigate through the documentation. The structure is designed to be intuitive based on the project's source code layout.