This is a public Github repo for my 2023 NEA Project. I have a private repo that's fully configured and hosted although I need to make another repo in order to publish code as there's Redis, SQL, and Email server information and password configured in most of the files.
My project is a smart Hotel Management System using Flask & tailwindcss, configuration will be needed to make it function completely which is detailed below.
- Flask backend /w API Routes
- Shortest Path Algorithm for room cleaning
- Dashboard for room data analysis
- SQLite Database for Room, User, and Order data
- Redis Queue Database to schedule room check-ins and check-outs
- User Login /w Account Registration and reset password emails
- Booking/Order Emails
- Receptionist Page to Create bookings and Check-out guests
- Automatic scheduling of housekeeping
- Normal Occupant and Do Not Disturb system as well as ability to request housekeeping
- and much much more :)
Landing Page: Order Page: Login Page: Dashboard Page (1): Dashboard Page (2): Receptionist Page: Housekeeping Page: Account Settings:
Firstly, make sure to have node.js and python installed then;
- run
npm i
ORnpm install
to install the node.js packages - run
pip install -r requirements.txt
to install all the required packages - if you intend on hosting it then please make sure to comment out
app.run
and instead useserve
!
If this isn't done, the CSS setup will not work and the program will not run without the intended packages
The SQL Server will run locally as flask-server.db
, if you want to change this then change the SQLALCHEMY_DATABASE_URI in the app config to the appropriate SQL Server.
Before running:
- Change the email server details in the
email_sender.py
file on lines 8-12 and lines 504-508. - Change the Redis server in the
app.py
file on lines 37 and 38. - Lastly, I'd recommend changing your secret key to something different.