Skip to content

tricolata/EagleEats

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EagleEats

Table of Contents

Setup and Installation

Requirements

Installation

Cloning

Clone and navigate to the repository:

git clone https://github.com/yafetkubrom/csce-3444-project/
cd csce-3444-project

Installing Packages

Install the required pip packages with the following command

pip3 install -r requirements.txt

Running

First, cd into the eagleseat directory:

cd eagleseat

Then, start the flask server:

python3 -m flask run

Documentation

Environment Variables

Environment variables used during the program are to be stored in a .env file inside of the eagleseat directory. An example file (.env.example ) is included.

The example file will be used if no .env file is present

Data Storage and Exchange

[]: # TODO: Write Data Storage and Exchange Documentation

Database Structure

[]: # TODO: Write Database Structure Documentation

Cart Structure

The cart is a delivery method key value pair and a JSON list of menu item IDs and option strings, stored in the cart session variable. For example:

{
    // requested delivery method
    "delivery_method": "takeout",

    // list of menu items
    "items": [
        {
            // id of menu item
            "id": 23,

            // list of option strings for menu item
            "options": [
                "No Pickles",
                "Extra Sour Cream",
                "Lite Ketchup"
            ]
        },
        {
            // id of another menu item
            "id": 2,

            // not every item needs modification options
            "options: []
        }
    ]
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •