Skip to content

faizan-akbar/Hostel-Management-System

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


🏢 Hostel Management Application

Developed with the MERN Stack and Redux, this application provides a comprehensive solution for managing hostel operations.

📦 Installation Instructions

  1. Clone the repository:
    git clone https://github.com/yourusername/hostel-management-app.git
  2. Navigate to the project directory:
    cd hostel-management-app
  3. Install backend dependencies:
    npm install
  4. Navigate to the frontend directory and install frontend dependencies:
    cd frontend && npm install

🛠️ Setup the .env File

Create a .env file in the root directory with the following content:

NODE_ENV=development
PORT=5000
MONGO_URI=Your MongoDB URI
JWT_SECRET=Your JWT Secret Key

🚀 Features

  • User Registration and Login
  • Student Information Management
  • Add New Students
  • Edit or Remove Student Details
  • Update Student Locations
  • Daily Attendance Tracking
  • Attendance Records Display
  • Export Attendance Data as CSV
  • Delete Attendance Records from Previous Days
  • User List Management
  • Modify User Admin Privileges
  • Admin-Only Data Control

📂 Project Structure

The project structure includes:

  • Backend: Contains the server-side code and APIs
  • Frontend: Contains the client-side code and React components
  • Redux: Used for state management

🌱 Environment Variables

.env.example

Here's an example of what your .env file should look like:

NODE_ENV=development
PORT=5000
MONGO_URI=Your MongoDB URI
JWT_SECRET=Your JWT Secret Key

📝 Usage

  1. Start the backend server:
    npm run server
  2. Start the frontend development server:
    cd frontend && npm start
  3. Open http://localhost:3000 to view the application in your browser.

🤝 Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues for any improvements or bug fixes.

📜 License

This project is licensed under the MIT License.


Releases

No releases published

Packages

No packages published

Languages