MunchOut

Restaurant event booking mobile application

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Documentation
4. Cross Platform
5. License

About The Project

• "MunchOut" was designed to provide local restaurants a means of promoting and managing bookings from customers for any daily events they plan on hosting, e.g. "20% off pizzas".

• Customers can book for the daily events , which adds the event to the customers booking tab.

• Restaurants can view what customers are coming for an individual event , by selecting the event on the cretaed events page.

• Different set of menus for the user types:

  • Customer User
    • Can book for events and view differnet events having booked for
  • Restaurant User
    • Can create events , view created events and view customers coming to each event.

Built With

Frontend:

Framework - Flutter
Language - Dart

Backend:

Language - Python
Framework - Flask
Database - MySQL

EndPoints Documentation

https://documenter.getpostman.com/view/16304569/UzBsHPsj

Clickup

Frontend Kanban

https://sharing.clickup.com/37426410/b/h/4-61251467-2/ada505352dad9da

Backend Kanban

https://sharing.clickup.com/37426410/b/h/4-61251472-2/285d29734561261

Design

Figma

https://www.figma.com/file/GJmIuobOWWiGpwq7ZIpiCe/ITMDA3-Mobile-App?node-id=0%3A1

(back to top)

Getting Started

Prerequisites

Each folder contains its own installation instructions

Frontend folder contains the flutter client application code.

frontend/README.md

Backend folder contains the flask REST API apploication code.

backend/README.md

Languages & FrameWork Installation

1. Install Flutter

https://docs.flutter.dev/get-started/install

2. Install Python 3.8.9

Later versions may cause failures. Packages may be incompatible
https://www.python.org/downloads/release/python-389/

3. Clone the repo

 git clone https://github.com/SparklingWater45/MunchOut

4. Follow both README setup instructions

Found in both backend and frontend folders

5. Run both backend & frontend applications

Ensure the IPV4 address is changed in both folders required files.
Run the python app.py file in its own terminal/cmd window.
Run the flutter app in a IOS/Android emulator of your choice.

(back to top)

Examples Screen Views

(back to top)

Cross Platform

Android

IOS

(back to top)

Documentation

Architecture

ER Diagram

Screens Flowchart

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Dylan van Heerden - @Soda_Water45 - dylanvh45@gmail.com

Project Link: https://github.com/SparklingWater45/MunchOut

(back to top)