sumitthorat / lightweight-restaurant-mgmt-system Goto Github PK

Lightweight Restaurant Management System

Team name: Bug Busters
Members and Contribution:
Sushil Kukreja (203050020) - Backend
Ankit Raj (203050047) - Backend, Frontend
Sumit Thorat (203050087) - Backend, Frontend
Ramswaroop (203050117)  -frontend

How to get the project running:
1. Clone the repository from https://github.com/sumitthorat/cs699-project
2. Navigate to the project directory and execute the following commands
3. Ensure all requirements are satisfied (will be installed if not satisfied): pip3 install -r Backend/API/requirements.txt
4. Run the API server: python3 Backend/API/main.py
5. Run the webapp: python3 Backend/Webapp/PROJECT/manage.py runserver
6. Install the APK Frontend/Android/app-debug.apk in the Android phone

How to access the webapp:
1. After setting up the project, scan the table specific QR code to open the webapp
2. Alternatively, type the url: http://localhost:8000/order/?table=1 in the web browser

How to access the Android app:
1. Copy the APK file to the mobile
2. Open the APK and let the mobile specific package manager install the APK (Needs "Install from unknown sources" option enabled in the settings)


Icons
1. Restaurant Brand icon: Flaticons.com
2. All other icons: Material.io

References
https://stackoverflow.com/questions/46370836/android-movable-draggable-floating-action-button-fab
https://socket.io/blog/native-socket-io-and-android/
https://www.youtube.com/watch?v=USbTcGx1mD0&list=PLk7v1Z2rk4hjHrGKo9GqOtLs1e2bglHHA
https://www.material.io
https://www.youtube.com/watch?v=GMppyAPbLYk&ab_channel=TechWithTim
https://flask-sqlalchemy.palletsprojects.com/en/2.x/
https://www.woolseyworkshop.com/2020/06/25/documenting-python-programs-with-doxygen/
https://stackoverflow.com/
https://stackoverflow.com/questions/25594893/how-to-enable-cors-in-flask
https://docs.djangoproject.com/en/3.1/intro
https://developer.mozilla.org/en-US/docs/Learn/Server-side/Django/skeleton_website
mnooner256/pyqrcode#39
https://stackabuse.com/encoding-and-decoding-base64-strings-in-python/