Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ctoic/hostel-management-system-using-flask
Application to streamline your hostel buisness.
https://github.com/ctoic/hostel-management-system-using-flask
contributions-welcome css3 flask good-first-issue hacktoberfest hacktoberfest2024 html javascript python3 sqlite3 web
Last synced: about 14 hours ago
JSON representation
Application to streamline your hostel buisness.
- Host: GitHub
- URL: https://github.com/ctoic/hostel-management-system-using-flask
- Owner: Ctoic
- Created: 2024-06-03T09:15:56.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-11-04T12:11:48.000Z (11 days ago)
- Last Synced: 2024-11-04T13:21:24.459Z (11 days ago)
- Topics: contributions-welcome, css3, flask, good-first-issue, hacktoberfest, hacktoberfest2024, html, javascript, python3, sqlite3, web
- Language: HTML
- Homepage: https://hostel-management-system-using-flask.vercel.app
- Size: 31.4 MB
- Stars: 1
- Watchers: 1
- Forks: 6
- Open Issues: 13
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Hostel Management System
This is a Flask-based web application for managing a hostel. It includes functionalities for enrolling students, managing rooms, tracking expenses, and more.
## Features
- Enroll students with details including name, fee, room number, and picture.
- Manage rooms and see which students are assigned to which rooms.
- Track monthly expenses by adding items and their prices.
- View a list of all students and rooms.
- Responsive design using Bootstrap.
## Technologies Used
- [Python](https://www.python.org/)
- [Flask](https://flask.palletsprojects.com/en/3.0.x/)
- [SQLAlchemy](https://www.sqlalchemy.org/)
- [Flask-WTF](https://flask-wtf.readthedocs.io/en/1.2.x/)
- [Bootstrap](https://getbootstrap.com/docs/5.3/getting-started/introduction/)
- [SQLite](https://www.sqlite.org/)
- [Pipenv](https://pipenv.pypa.io/en/latest/)
## Recommended Dev Tools
- [VS Code](https://code.visualstudio.com/download)
- [Black Formatter](https://code.visualstudio.com/docs/python/formatting)
## Setup and Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/Hostel-Management-System-Using-Flask.git
cd Hostel-Management-System-Using-Flask
```
2. Create a virtual environment and activate it (virtual environment directory name is `.venv`):
```bash
python3 -m venv .venv
source .venv/bin/activate # On Windows use `.venv\Scripts\activate`
```
3. Install `pipenv` package manager
```bash
pip install pipenv
```
4. Install the dependencies:
```bash
pipenv install
```
5. Initialize the database:
```bash
flask db init
flask db upgrade
```
6. Run the application:
```bash
flask run
```
7. Open your browser and navigate to `http://127.0.0.1:5000`.
## Application Structure
- `app.py`: Main application file containing routes and logic.
- `models.py`: Database models for Student, Room, and Expense.
- `forms.py`: Forms for enrolling students and adding expenses.
- `templates/`: HTML templates for the application pages.
- `static/`: Static files including CSS and images.
- `migrations/`: Database migration files.
## Routes
- `/`: Home page with links to enroll, view students, view rooms, and manage expenses.
- `/enroll`: Form to enroll a new student.
- `/students`: List of all enrolled students.
- `/rooms`: List of all rooms and their assigned students.
- `/expenses`: Form to add expenses and view total monthly expenses.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## Contact
For any questions or suggestions, please contact [[email protected]](mailto:[email protected]).