/Hostel_Manager

Primary LanguageHTML

Hostel Manager

Welcome to Hostel Manager! This web application is designed to help manage various hostel-related tasks such as outpass requests, complaints, notices, and finding roommates. It has been developed using the Flask framework.

Features

  • Outpass Requests: Students can submit outpass requests online, providing the necessary details such as date, time, reason, etc. The requests can be reviewed and approved/rejected by the hostel authorities.

  • Complaints: Students can file complaints regarding any issues they face in the hostel. The complaints are recorded and can be assigned to the concerned staff members for resolution.

  • Dashboard: Important notices and announcements can be posted on the notice board for all students to view. The notices can be categorized and sorted by date.

  • Roommate Finder: Students who are looking for roommates can create profiles and search for suitable roommates based on preferences such as gender, hobbies, interests, etc.

Design

This is the reference design for this wesite made in figma👇:
https://www.figma.com/file/vpSNoPU7tGDa9F0ao8t3Y1/Hostel-Management?type=design&node-id=0%3A1&t=42NxzP4bVg6ir5OR-1

Video Reference

This is a sample video reference of the website and any contributions to this website are invited ✨✨:

Hostel.Manager.Website.mp4

Installation

  1. Clone the repository: https://github.com/Upendra2003/Hostel_Manager.git
  2. Navigate to the project directory: cd hostel-manager
  3. Create a virtual environment: python -m venv venv
  4. Activate the virtual environment:
    • On Windows: venv\Scripts\activate
    • On macOS/Linux: source venv/bin/activate
  5. Install the required dependencies: pip install -r requirements.txt

Configuration

  1. Rename the config_example.py file to config.py.
  2. Open the config.py file and modify the configuration parameters as per your requirements. For example, you might want to set the database credentials, secret key, etc.

Usage

  1. Activate the virtual environment if it's not already activated: source venv/bin/activate
  2. Run the Flask development server: flask run
  3. Open your web browser and visit http://localhost:5000 to access the Hostel Manager application.

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue on the GitHub repository.

  1. Fork the repository.
  2. Create a new branch: git checkout -b my-new-branch
  3. Make your changes and commit them: git commit -am 'Add new feature'
  4. Push the branch: git push origin my-new-branch
  5. Submit a pull request.

Acknowledgments

We would like to express our gratitude to the following resources and libraries that made this project possible:

Contact

If you have any questions or need further assistance, please feel free to contact us: