UniResto

Description

UniResto is a mobile application that makes restaurant reservations easy. Users can make reservations at a public or private restaurants using virtual tickets.
The app also provides real-time updates on the status of your reservation and the restaurant, including any changes to the estimated wait time and the status of the queue. Additionally, the app gives restaurants the ability to verify and confirm reservations or cancel them if needed, which help them manage their queues more effectively.

Features

Real-time updates: Users can receive real-time updates on the status of their reservation, including any changes to the estimated wait time and the status of the queue.
Verification and confirmation: Restaurants can verify and confirm reservations made through the app, or cancel them if needed.

Technologies

This restaurant reservation app includes a React Native front-end for the mobile application, a FastAPI back-end for handling the API calls, and a MySQL database for storing information about the restaurants, reservations, and users. The app uses React Native for the mobile interface, allowing for easy development and deployment on both iOS and Android platforms. The FastAPI back-end provides a fast and efficient way to handle the API calls, while the MySQL database allows for easy storage and retrieval of the app's data. The virtual tickets feature is implemented through the use of unique QR codes, which are generated and stored in the database for each reservation.

React Native a popular open-source framework for building cross-platform mobile applications using React.
FastAPI a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
MySQL a widely used, open-source relational database management system that is known for its reliability, robustness and performance.

Requirements:

MySQL
Virtual Environment : To create a virtual environment using python, use the command python -m venv env in your project directory. This will create a new folder named "env" which contains the virtual environment.
To activate the virtual environment, use the command source bash env/bin/activate on Linux/macOS or env\Scripts\activate on Windows
FastAPI : run these commands(pyhton needs to be already installed):

pip install "fastapi[all]
pip install "uvicorn[standard]"
pip install python-multipart
pip install "python-jose[cryptography]"
pip install "passlib[bcrypt]"
pip install sqlalchemy
pip install mysqlclient"

React Native
Emulator(Android Studio) or Expo Go on your phone.

Configuration

Database Configuration :

To create a database in your local machine you need to run these commands:

bash mysql -u root -p
Enter MySQL password(the one created when you installed mySQL]
bash CREATE DATABASE DATABASE_NAME
To connect the back-end to the MySQL database, you will need to replace the placeholder password in the database.py with your actual MySQL password and the placeholder "DATABASE_NAME" with the name of the database you have created. The tables for the database will be automatically created when the code runs successfully.

How to run this code

First you have to clone this repository :

git clone https://github.com/Soulaimene/UniResto.git

then open the terminal and type :

cd UniResto/Resto-App/
uvicorn fast_back.main:app --reload

Also, you have to use another terminal for the Bank.py :

cd UniResto/Resto-App/Bank
python main.py

and Finally, another terminal for the frontend

cd UniResto/Restp-App/UniResto
npm start

then press a inside the terminal to open the Emulator.

Interface Instructions

After, Running the code please follow the instructions :

Creating an account:

Open the UniResto app.
Tap on "Create an Account".
Fill in your personal information such as your name, email, and password,and specify the type of user you are(student or worker).
Tap on "Create Account" button to complete the process.

Loging in:

Open the UniResto app.
Enter your email and password and specify the type of user you are(student or worker).
Tap on "Log In" button to access your account.

Purshasing tickets(student):

Open the UniResto app and log in.
Tap on "Purshase Tickets" at the bottom of the screen.
Fill in your personal information.
specify the number of tickets your buying .
Tap on "Purshase" to finish the transaction.

Make reservation(student):

Open the UniResto app and log in.
Buy tickets if you don't have any.
If the restaurant is not active , wait for the worker to activate it.
If the restaurant is active,Tap on "Make a reservation".

Check The menu(Student):

Open the UniResto app and log in.
If the restaurant is not active , wait for the worker to activate it.
Once the restaurant is activated,the button "Check Menu" will appear, Tap on it

Verify or cancel your reservation:

Open the UniResto app and log in.
If you don't have a reservation,follow the steps on making one.
Tap on the "manage reservation" to go your reservation page.
To cancel your reservation tap on cancel your reservation
To verify your reservation show your QRcode to the worker.

Create a Restaurant State:

Open the UniResto app and log in. 2.Tap on "create State".
Enter the information of this meal.
Tap On "create State".

Manage the queue and the reservations:

Open the UniResto app and log in.
If there is no reservation active , follow the previous steps to create one.
If the restaurant is not able to serve student , tap on "freeze" to announce that the queue is not moving, and tap "unfreeze" when the service is back.
Once the stuff is ready , tap "open" to announce to the students that the restaurant is now serving.
If the student is not present for his/her reservation, tap cancel reservation.
If the student is present,tap scan to open the camera and then scan his QRcode.
Once the time comes, tap "close" to close the restaurant state.