Corey Mcmahon commited on
Commit
cb2af73
1 Parent(s): 2bf2c38

Initial indexing (9 pages, approx 2mb index)

Browse files
.gitattributes CHANGED
@@ -32,3 +32,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
32
  *.zip filter=lfs diff=lfs merge=lfs -text
33
  *.zst filter=lfs diff=lfs merge=lfs -text
34
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
32
  *.zip filter=lfs diff=lfs merge=lfs -text
33
  *.zst filter=lfs diff=lfs merge=lfs -text
34
  *tfevents* filter=lfs diff=lfs merge=lfs -text
35
+ *.json filter=lfs diff=lfs merge=lfs -text
README.md CHANGED
@@ -10,4 +10,13 @@ pinned: false
10
  license: unknown
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
10
  license: unknown
11
  ---
12
 
13
+ Make sure `OPENAI_API_KEY` environment variable is set with your API key.
14
+
15
+ Configure list of URLs to index in [urls.txt](urls.txt).
16
+
17
+ Fetch, parse and transform the source documents to markdown using `./bin/fetch.sh`.
18
+
19
+ Embed the documents using `tba`.
20
+
21
+ Start the project with `python3 app.py` and navigate to `https://127.0.0.1:7860`.
22
+
app.py ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ import gradio as gr
2
+ from gpt_index import GPTSimpleVectorIndex
3
+
4
+ def chatbot(input_text):
5
+ index = GPTSimpleVectorIndex.load_from_disk('index.json')
6
+ response = index.query(input_text, response_mode="compact")
7
+ return response.response
8
+
9
+ iface = gr.Interface(fn=chatbot, inputs="text", outputs="text")
10
+ iface.launch()
bin/fetch.py ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import argparse
2
+ import requests
3
+ from bs4 import BeautifulSoup
4
+ import markdownify
5
+
6
+ # CLI args
7
+ parser = argparse.ArgumentParser(description='Extract article content from a web page and convert to markdown')
8
+ parser.add_argument('url', metavar='URL', type=str, help='The URL to extract content from')
9
+ args = parser.parse_args()
10
+
11
+ # Get article and convert it to markdown
12
+ response = requests.get(args.url)
13
+ soup = BeautifulSoup(response.content, 'html.parser')
14
+ article = soup.find('div', {'class': 'article'})
15
+ # Change the <header> section inside article to a <h1>
16
+ header = article.find('header')
17
+ header.name = 'h1'
18
+ # Remove the div with class="avatar"
19
+ avatar_div = article.find('div', {'class': 'avatar'})
20
+ avatar_div.extract()
21
+
22
+ markdown_text = markdownify.markdownify(article.renderContents(), heading_style="ATX")
23
+
24
+ print(markdown_text)
bin/fetch.sh ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ #!/bin/sh
2
+ while read line; do
3
+ echo "Fetching $line..."
4
+ python3 bin/fetch.py $line > data/$(basename $line).md
5
+ echo "Done."
6
+ echo ""
7
+ done < urls.txt
bin/index.py ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ from gpt_index import SimpleDirectoryReader, GPTListIndex, GPTSimpleVectorIndex, LLMPredictor, PromptHelper
2
+ from langchain.chat_models import ChatOpenAI
3
+ import gradio as gr
4
+ # import os
5
+
6
+ def construct_index(directory_path):
7
+ max_input_size = 4096
8
+ num_outputs = 512
9
+ max_chunk_overlap = 20
10
+ chunk_size_limit = 600
11
+
12
+ prompt_helper = PromptHelper(max_input_size, num_outputs, max_chunk_overlap, chunk_size_limit=chunk_size_limit)
13
+
14
+ llm_predictor = LLMPredictor(llm=ChatOpenAI(temperature=0.7, model_name="gpt-3.5-turbo", max_tokens=num_outputs))
15
+
16
+ documents = SimpleDirectoryReader(directory_path).load_data()
17
+
18
+ index = GPTSimpleVectorIndex(documents, llm_predictor=llm_predictor, prompt_helper=prompt_helper)
19
+
20
+ index.save_to_disk('index.json')
21
+
22
+ return index
23
+
24
+ def chatbot(input_text):
25
+ index = GPTSimpleVectorIndex.load_from_disk('index.json')
26
+ response = index.query(input_text, response_mode="compact")
27
+ return response.response
28
+
29
+ index = construct_index("data")
data/3868573-foodkit-core-platform-overview.md ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Foodkit Core Platform Overview
2
+
3
+ # **Overview**
4
+
5
+ The Foodkit Core Platform provides you with a full suite of digital tools to manage and grow your restaurant’s online presence. It includes a wide range of features:
6
+
7
+ * **Content Management**: update your branch and menu content quickly and easily for all digital channels in one place.
8
+ * **CRM (Customer Relationship Management)**: access a comprehensive history of each customer’s interactions with your restaurant so you can provide better support and an individually tailored customer service experience.
9
+ * **Analytics**: see comprehensive and accurate sales and engagement metrics across your entire restaurant chain in real-time so you can track growth and make better marketing and operational decisions.
10
+ * **Marketing Tools**: configure promotional banners and pop-ups for your digital channels, as well as send targeted SMSs and push notifications to drive sales and reactivate customers.
11
+ * **Real-time Order Management Dashboard**: see a dynamic 360-degree view of all orders being processed by your restaurant chain in real-time, so your customer service team can proactively deal with incidents and provide customers with the best possible brand experience.
12
+ * **Loyalty Program**: an industry-leading loyalty program which rewards your customers when they spend money with your restaurant.
13
+ * **User Access Controls and Auditing**: fine-grained control over who can view and change data and settings for your restaurants, and an auditable log of changes made by your team.
14
+ * **Data Portability**: export all customer and order details in an easily portable format so you have complete ownership and control over your data.
15
+ This Foodkit Core Platform Guide will provide you with comprehensive and easy to understand instructions on how to get the most out of the Foodkit Platform.
16
+
17
+
18
+
19
+ # **Logging In**
20
+
21
+ In order to access the Foodkit Core Platform, first navigate to the URL for your Foodkit instance. This URL is provided to you during the onboarding process, but if you do not have access to or cannot remember it you may request it from technical support or your account manager.
22
+
23
+
24
+
25
+ [![](https://downloads.intercomcdn.com/i/o/518756772/d8295e4fa1dca8d30769011f/Log+in.png)](https://downloads.intercomcdn.com/i/o/518756772/d8295e4fa1dca8d30769011f/Log+in.png)After navigating to the Foodkit URL, enter the **Email Address** and **Password** you used to register your Foodkit account and press **Login**. There will be a short delay and (if the credentials were correctly entered) you will be logged in and redirected to the **Dashboard** page.
26
+
27
+
28
+
29
+ # **Forgotten Passwords**
30
+
31
+ If you cannot log in with your credentials or cannot remember your password, you may click on the **Forgot your password** link at the bottom left hand corner of the login form. This will redirect you to a page where you can enter your email address, which we will use to send a secure password reset link. Check your inbox after a short delay (10-15 seconds) and follow the instructions on the password reset email.
32
+
33
+
34
+
35
+ [![](https://downloads.intercomcdn.com/i/o/518758822/bf61a7449ef8ab6028d2e00b/FORGOTTEN+PASS+SS.png)](https://downloads.intercomcdn.com/i/o/518758822/bf61a7449ef8ab6028d2e00b/FORGOTTEN+PASS+SS.png)
data/3868574-analytics.md ADDED
@@ -0,0 +1,43 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Analytics
2
+
3
+ # **Overview**
4
+
5
+ The Foodkit Core Platform platform includes a dedicated **Analytics** section. The Analytics menu allows you to view revenue and sales numbers across different date periods, and also provides you with the ability to generate and export a number of detailed reports for external analysis and/or importing into third-party business intelligence tools.
6
+
7
+
8
+
9
+ When you click on the **Analytics** menu item the first page that appears shows a summary of the key revenue and transaction number metrics. This includes three summary panels and a line graph plotting the number of orders and total revenue for the specified date range.
10
+
11
+
12
+
13
+ [![](https://downloads.intercomcdn.com/i/o/518759511/948c6109d7fd139916051449/Analytics.png)](https://downloads.intercomcdn.com/i/o/518759511/948c6109d7fd139916051449/Analytics.png)# **Date Selector**
14
+
15
+ At the top left hand side of the page is a date selector. This will default to the past week upon first opening the page, but can be changed by clicking on it. The following presets are available: Today, Yesterday, Last 7 days, Last 30 days, This month and Last month. You can also select a custom date range by clicking on the **Custom Range** option and specifying a start and end date. Don’t forget to click **Apply** before closing the date selector, otherwise the data will not be updated to reflect the selected date range.
16
+
17
+
18
+
19
+ [![002_Analytics_-_date_selector_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105605/67866817d58301497743ed1f/002_Analytics_-_date_selector_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105605/67866817d58301497743ed1f/002_Analytics_-_date_selector_1.png)# **Revenue**
20
+
21
+ At the very top of the **Analytics** page are 3 metrics panels. The first panel shows the total revenue generated through the Foodkit Core Platform for the selected date range. This includes sales across all Foodkit Core Platform enabled channels, including web, mobile apps and phone orders entered via the Foodkit Customer Service Pro (CSPro).
22
+
23
+
24
+
25
+ [![](https://downloads.intercomcdn.com/i/o/518760140/15bd216428244b02c91f3aac/Revenue+SS.png)](https://downloads.intercomcdn.com/i/o/518760140/15bd216428244b02c91f3aac/Revenue+SS.png)# **Orders**
26
+
27
+ The second panel shows the total number of orders for the selected date range.
28
+
29
+
30
+
31
+ [![](https://downloads.intercomcdn.com/i/o/518760506/c850e0528283f0005456f4d7/ORDERS+ANALYTICS+SS.png)](https://downloads.intercomcdn.com/i/o/518760506/c850e0528283f0005456f4d7/ORDERS+ANALYTICS+SS.png)# **Average Order Value**
32
+
33
+ The final panel shows the average order value (also known as “average basket size”).
34
+
35
+
36
+
37
+ [![](https://downloads.intercomcdn.com/i/o/518760863/ce8bc3c2d62f710850ca3966/AVE+ORDER.png)](https://downloads.intercomcdn.com/i/o/518760863/ce8bc3c2d62f710850ca3966/AVE+ORDER.png)# **Line Graph**
38
+
39
+ The graph below the 3 metrics panels on the **Analytics** page shows the number of orders and total revenue on a daily basis for the specific date range.
40
+
41
+
42
+
43
+ [![](https://downloads.intercomcdn.com/i/o/518761209/18ffcd8e5e190e48dec74814/LINE+GRAPH+SS.png)](https://downloads.intercomcdn.com/i/o/518761209/18ffcd8e5e190e48dec74814/LINE+GRAPH+SS.png)
data/3868575-loyalty-dashboard.md ADDED
@@ -0,0 +1,74 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Loyalty Dashboard
2
+
3
+ # **Overview**
4
+
5
+ The Foodkit Core Platform includes a comprehensive punchcard-based loyalty program. It enables you to define “rewards” which can be unlocked by your customers when they spend money with your brand. The rewards provide your customers with exclusive discounts which can be redeemed via your website, in your mobile apps and in your physical store locations.
6
+
7
+
8
+
9
+ **Note**: the Foodkit Loyalty Program is typically sold under a different license to the Foodkit Core Platform. Please contact your account manager if you would like more information about enabling it for your restaurant. Also note that support for offline (in-store) redemption of rewards is dependent on POS vendor support.
10
+
11
+
12
+
13
+ All subsequent pages under this section assume the loyalty program is enabled for your restaurant.
14
+
15
+
16
+
17
+ # **Dashboard**
18
+
19
+ Clicking on **Loyalty** in the navigation menu will take you to the **Dashboard** for your loyalty program. The **Dashboard** shows a high-level overview of the key metrics for your loyalty program.
20
+
21
+
22
+
23
+ [![](https://downloads.intercomcdn.com/i/o/518801298/3b26a33f482cd0b5fe4834d9/Loyalty+Dashboard.png)](https://downloads.intercomcdn.com/i/o/518801298/3b26a33f482cd0b5fe4834d9/Loyalty+Dashboard.png)# **Metrics contained on the dashboard**
24
+
25
+ The dashboard contains 7 different metrics panels and a date selector at the top right hand corner of the screen. The date selector will control which time period is used when presenting date-specific analytics. The selected date will be set to the current month by default, but it can be manually adjusted by clicking on it and selecting a different date range.
26
+
27
+
28
+
29
+ Note that the 2 top-most metrics panels are *not date specific* but instead provide statistics for *all time*. Changing the date range will not impact these panels.
30
+
31
+
32
+
33
+ The metrics in each panel are explained below.
34
+
35
+
36
+
37
+ [![002_Loyalty_-_dashboard__graph_explanation_1_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105616/647c3433a16b674eb621d6cd/002_Loyalty_-_dashboard__graph_explanation_1_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105616/647c3433a16b674eb621d6cd/002_Loyalty_-_dashboard__graph_explanation_1_1.png)
38
+ The left top-most panel contains three metrics (note that these are not impacted by the selected date range):
39
+
40
+
41
+
42
+ * **Total members**: this is the number of member registrations for *all time*.
43
+ * **Members growth last week**: the number of members who have registered in the past 7 days.
44
+ * **Members growth last month**: the number of members who have registered in the previous 31 day period.
45
+
46
+
47
+ The **Member Signups** panel shows a line graph of the total loyalty program registrations on a daily basis.
48
+
49
+
50
+
51
+
52
+
53
+ [![006_Loyalty_-_dashboard_graph_explanation_5_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105624/0fc60bb999b0bb08d090aed5/006_Loyalty_-_dashboard_graph_explanation_5_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105624/0fc60bb999b0bb08d090aed5/006_Loyalty_-_dashboard_graph_explanation_5_1.png)
54
+ At the very bottom of the **Dashboard** are two lists:
55
+
56
+
57
+
58
+ [![007_Loyalty_-_dashboard_graph_explanation_6_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105626/4f6d310032273b817904421d/007_Loyalty_-_dashboard_graph_explanation_6_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105626/4f6d310032273b817904421d/007_Loyalty_-_dashboard_graph_explanation_6_1.png)* **Top 5 Members by Points**: this shows the top 5 points-earning loyalty program members for the selected date range.
59
+ * **Best Performing Stores by Points**: this shows the top 5 stores based on the number of points earned at that location.
60
+ # **Date selector**
61
+
62
+ The date selector controls the period for which data is displayed on this page for all metrics panels, *excluding* the two top-most panels which are not controlled by the date selector.
63
+
64
+
65
+
66
+ The default date range is set to the current month. By clicking on the date range selector you can change the period to another of preset options including: Today, Yesterday, Last 7days, Last 30 days, This month and Last month. You can also specify a **Custom range** by clicking that option and specifying the exact start and end date of the time for which you wish to see data.
67
+
68
+
69
+
70
+ Don’t forget to click “Apply” before closing the date selector to update the metrics.
71
+
72
+
73
+
74
+ [![008_Loyalty_-_dashboard_date_selector_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105627/34fba71784690af4118874a7/008_Loyalty_-_dashboard_date_selector_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105627/34fba71784690af4118874a7/008_Loyalty_-_dashboard_date_selector_1.png)
data/3868577-outlets-overview.md ADDED
@@ -0,0 +1,69 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Outlets Overview
2
+
3
+ # **Overview**
4
+
5
+ Clicking **Outlets** in the navigation menu will take you to the outlet management portion of the Foodkit Core Platform. This section of the application enables you to view and edit existing outlet content and settings (addresses, delivery zones, service hours, etc.) as well as activate new restaurant locations (if your Foodkit license supports additional *active locations*).
6
+
7
+
8
+
9
+ [![](https://downloads.intercomcdn.com/i/o/518766763/1367a1155d1de5d4aeb139ca/Outlets.png)](https://downloads.intercomcdn.com/i/o/518766763/1367a1155d1de5d4aeb139ca/Outlets.png)# **Status Filter**
10
+
11
+ The *Status Filter* at the top left hand side of the list can be used to control which outlets are visible in the table. The filter can be adjusted by clicking on the relevant status you wish to filter the outlets by (**Active** or **Inactive**), or by clicking **All** to show all locations regardless of status.
12
+
13
+
14
+
15
+ [![002_Branches_-_status_filter_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105634/ce92b8fbac57eb0d823bd7db/002_Branches_-_status_filter_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105634/ce92b8fbac57eb0d823bd7db/002_Branches_-_status_filter_1.png)# **Search and Reset**
16
+
17
+ You can also search for a specific restaurant location by *name* of the outlets or the *outlet* code. Click reset to remove the filter.
18
+
19
+
20
+
21
+ [![](https://downloads.intercomcdn.com/i/o/518767341/c973a20ace64c1096c14602a/Search+Outlet+ss.png)](https://downloads.intercomcdn.com/i/o/518767341/c973a20ace64c1096c14602a/Search+Outlet+ss.png)# **Outlets List Explanation**
22
+
23
+ Each row in the table represents a single restaurant location. The columns for each row include a checkbox (for initiating bulk actions), the restaurant’s logo, the outlet name, and three different status flags: *pickup* enabled/disabled, *delivery* enabled/disabled and the restaurant’s activation state (active/inactive).
24
+
25
+
26
+
27
+ [![](https://downloads.intercomcdn.com/i/o/518767584/3f0c28770566dbf40fd44030/Outlet+Expansion+SS.png)](https://downloads.intercomcdn.com/i/o/518767584/3f0c28770566dbf40fd44030/Outlet+Expansion+SS.png)# **Bulk Actions**
28
+
29
+ After selecting one or more outlets from the list view via the checkboxes, the user can initiate *bulk actions* for the selected outlets. Bulk actions include:
30
+
31
+ * **Make outlets active/inactive**: marking a outlet as *inactive* will remove it from the platform for all ordering actions. Consumers will not be able to see or order from the outlet.
32
+ * **Turn on/off pickup**: turning pickup *off* will cause the outlet to be removed from the list of available outlets when consumers select the *pickup* fulfillment option.
33
+ * **Turn on/off delivery**: turning delivery *off* will disable the outlets service area, so customers who attempt to order from within the service area of the outlet will either fall-back to other active outlet with overlapping service areas or will receive an “out of delivery zone” alert.
34
+ [![](https://downloads.intercomcdn.com/i/o/518767963/7aa14feaf244253a3f4b35b8/Actions.png)](https://downloads.intercomcdn.com/i/o/518767963/7aa14feaf244253a3f4b35b8/Actions.png)# **Outlet Actions**
35
+
36
+ Clicking on the gear icon at the very right of a specific outlet location will open the action list for the outlet. The action list includes the following options:
37
+
38
+
39
+
40
+
41
+
42
+ [![](https://downloads.intercomcdn.com/i/o/518768303/6f695ded58d5e51247c290f5/More+Settings.png)](https://downloads.intercomcdn.com/i/o/518768303/6f695ded58d5e51247c290f5/More+Settings.png)* Edit
43
+ * Enable/Disable outlet
44
+ * Ordering Hours
45
+ * Service Area
46
+ * Staff Accounts
47
+ # **Enable/Disable Outlet**
48
+
49
+ Selecting **Disable** from the action list for a currently *active* outlet will deactivate it. Deactivating a outlet will hide it from the website and/or application(s) for consumers and prevent new orders being created for the outlet. Selecting **Enable** for a currently *inactive* outlet will reverse the action.
50
+
51
+
52
+
53
+ # **New Outlet**
54
+
55
+ [![006_Branches_-_action_menu_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105642/cd8f309092ad4ca4a0a4c6ad/006_Branches_-_action_menu_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105642/cd8f309092ad4ca4a0a4c6ad/006_Branches_-_action_menu_1.png)While on the outlet **list** page you can also add a new restaurant location to the Foodkit platform (assuming your license supports it) by clicking on the **New Outlet** button.
56
+
57
+
58
+
59
+ [![030_Branches_-_new_branch_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105643/e9e26a08adf761193536a501/030_Branches_-_new_branch_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105643/e9e26a08adf761193536a501/030_Branches_-_new_branch_1.png)# **Why do I see “Maximum active outlets limit reached”?**
60
+
61
+ You may receive a “Maximum active outlets limit” error message when trying to add a new restaurant location to your Foodkit account. This means that you have reached the maximum number of active restaurant locations according to your current Foodkit license.
62
+
63
+
64
+
65
+ In order to add new active outlets you must either disable existing active outlets, or purchase additional licenses for the locations you wish to add. Please contact your account manager to find out more information.
66
+
67
+
68
+
69
+ [![031_Branches_-_maximum_active_branches_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105644/add48cbbdbba1a4d1b4dbca5/031_Branches_-_maximum_active_branches_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105644/add48cbbdbba1a4d1b4dbca5/031_Branches_-_maximum_active_branches_1.png)
data/3868578-customers-overview.md ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Customers Overview
2
+
3
+ # **Overview**
4
+
5
+ The **Customers** page provides your team with a Customer Relationship Management system within the Foodkit Core Platform so you can quickly and easily view, manage and export 100% of your customer data.
6
+
7
+
8
+
9
+ [![](https://downloads.intercomcdn.com/i/o/518769026/216ef42a95018504f3439ac4/Customer+SS.png)](https://downloads.intercomcdn.com/i/o/518769026/216ef42a95018504f3439ac4/Customer+SS.png)Upon opening the **Customers** page within the Foodkit Core Platform, you will be presented with a list of customers who have signed up through your Web or App eCommerce website.
10
+
11
+
12
+
13
+ # **Search and Reset**
14
+
15
+ [![002_Customers_-_search_and_reset_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105649/4b8778838e5b8f3f75843c1c/002_Customers_-_search_and_reset_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105649/4b8778838e5b8f3f75843c1c/002_Customers_-_search_and_reset_1.png)To find a specific customer, you can enter a range of queries including name, telephone or email.
16
+
17
+
18
+
19
+ # **Customer List Explanation**
20
+
21
+ [![003_Customers_-_list_explanation_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105650/3d4f99843a7136fb199eda24/003_Customers_-_list_explanation_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105650/3d4f99843a7136fb199eda24/003_Customers_-_list_explanation_1.png)Each row will include the name, email address, phone number and registration date of one of your customers. You can access the **Customer details page** for a specific customer simply by clicking on the row in the table for that customer.
22
+
23
+
24
+
25
+ # **Export Customer Data**
26
+
27
+ [![004_Customers_-_export_1_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105652/15f49aa3953b3f6f6808060a/004_Customers_-_export_1_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105652/15f49aa3953b3f6f6808060a/004_Customers_-_export_1_1.png)[![005_Customers_-_export_2_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105654/eb7281710649518e98fec5bd/005_Customers_-_export_2_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105654/eb7281710649518e98fec5bd/005_Customers_-_export_2_1.png)You can click the **Export Customers** button at the bottom right of the customer list to export all customer records to an Excel spreadsheet file. Depending on the size of your customer database it may take some time for the report to generate. After it has been processed, you will receive a secure link via email which you can use to download the customer list.
28
+
29
+
30
+
31
+ # **Create Order**
32
+
33
+ If you’ve purchased the *Customer Service Pro* (CSPro) add-on in your Foodkit subscription, you can create a new order from this page by clicking on the **New Order** button. This will open the Create Order Wizard which is described in another section.
34
+
35
+
36
+
37
+ [![006_Customers_-_create_order_1.png](https://foodkit.intercom-attachments-1.com/i/o/198105655/b4348932b958eff971a6266a/006_Customers_-_create_order_1.png)](https://foodkit.intercom-attachments-1.com/i/o/198105655/b4348932b958eff971a6266a/006_Customers_-_create_order_1.png)
data/3868580-order-details.md ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Order Details
2
+
3
+ # **Overview**
4
+
5
+ After clicking on **Edit Order** from the action items list the user is shown a summary of the order.
6
+
7
+
8
+
9
+ [![](https://downloads.intercomcdn.com/i/o/518773738/7a91a602bbd308f91b2faa29/Edit+Order.png)](https://downloads.intercomcdn.com/i/o/518773738/7a91a602bbd308f91b2faa29/Edit+Order.png)# **Print Order**
10
+
11
+ Clicking on **Print Order** will open a printer friendly single-page summary of all the order information.
12
+
13
+
14
+
15
+ [![](https://downloads.intercomcdn.com/i/o/518774181/4de74a8f529c355968772932/Print.png)](https://downloads.intercomcdn.com/i/o/518774181/4de74a8f529c355968772932/Print.png)
16
+
17
+ # **Update Order Status**
18
+
19
+ By clicking on the **Order Status** drop-down the user can manually update the status of the order.
20
+
21
+
22
+
23
+ [![](https://downloads.intercomcdn.com/i/o/518774523/3dbe7ccd2a168fa351cbd85b/Order+Stats+SS.png)](https://downloads.intercomcdn.com/i/o/518774523/3dbe7ccd2a168fa351cbd85b/Order+Stats+SS.png)
24
+
25
+ # **Edit Customer Details**
26
+
27
+ This section displays the current customer details for the order. Clicking **Edit** will open a modal window from which the customer information (name, email, phone number) can be updated.
28
+
29
+
30
+
31
+ [![](https://downloads.intercomcdn.com/i/o/518774778/9dec9f85e34442d5b67af839/Edit+CX+SS.png)](https://downloads.intercomcdn.com/i/o/518774778/9dec9f85e34442d5b67af839/Edit+CX+SS.png)
data/3868581-action-items.md ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Action Items
2
+
3
+ # **Overview**
4
+
5
+ Foodkit Core Platform users can also edit the *Orders* on the *Order Menu* by clicking the **Action Item** button on the far right of each *Orders* on the dashboard
6
+
7
+ [![007_Orders_-_action_items_1__1_.png](https://foodkit.intercom-attachments-1.com/i/o/198105660/f7969f80a857889bd8fd1e3e/007_Orders_-_action_items_1__1_.png)](https://foodkit.intercom-attachments-1.com/i/o/198105660/f7969f80a857889bd8fd1e3e/007_Orders_-_action_items_1__1_.png)# **Edit Order**
8
+
9
+ Clicking on **Edit Order** will open the details of the order. On the order details page the user can perform updates such as changing the customer information or manually altering the status of the order.
10
+
11
+
12
+
13
+ # **Print Invoice**
14
+
15
+ This will open a single-page summary of the order which can be printed out for external reference.
16
+
17
+
18
+
19
+ # **Mark Order as Test**
20
+
21
+ Marking an order as a “test” will remove it from all user interfaces and reports in the Foodkit Platform.
22
+
23
+
data/3868582-orders-overview.md ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ # Orders Overview
2
+
3
+ ## Overview
4
+
5
+ The orders page enables you to view and manage customer orders for your restaurant. The first thing you’ll see upon entering this page is a reverse chronological sorted list of orders received for your restaurant.
6
+
7
+
8
+
9
+ [![](https://downloads.intercomcdn.com/i/o/518782379/01bd89837612ddbb0c62c511/Orders+Overview+ss.png)](https://downloads.intercomcdn.com/i/o/518782379/01bd89837612ddbb0c62c511/Orders+Overview+ss.png)
data/3868583-dashboard-page-overview.md ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Dashboard - Page Overview
2
+
3
+ ## Overview
4
+
5
+ The dashboard is the first page users see after logging in to Foodkit Core Platform.
6
+
7
+
8
+
9
+ [![](https://downloads.intercomcdn.com/i/o/518783309/4b9bb7ef8b747e418c994045/Dashboard+SS.png)](https://downloads.intercomcdn.com/i/o/518783309/4b9bb7ef8b747e418c994045/Dashboard+SS.png)Dashboard (home) is an aggregated overview of key platform metrics. The below sections will outline each section in detail.
10
+
11
+
12
+
13
+ **[Key Metrics](https://app.intercom.com/a/apps/kxp2tck0/articles/articles/3868604/show?request=%7B%22conditions%22%3A%7B%22languages%22%3A%5B%5D%2C%22status%22%3A%22%22%2C%22collection_ids%22%3A%5B%222243179%22%5D%7D%2C%22order%22%3A%7B%22direction%22%3A%22desc%22%2C%22key%22%3A%22updated_at%22%7D%7D)**
14
+
15
+ **[Graphical Representation](https://app.intercom.com/a/apps/kxp2tck0/articles/articles/3868610/show?request=%7B%22conditions%22%3A%7B%22languages%22%3A%5B%5D%2C%22status%22%3A%22%22%2C%22collection_ids%22%3A%5B%222243179%22%5D%7D%2C%22order%22%3A%7B%22direction%22%3A%22desc%22%2C%22key%22%3A%22updated_at%22%7D%7D)**
16
+
17
+ **[Outlet Performance](https://app.intercom.com/a/apps/kxp2tck0/articles/articles/3868612/show?request=%7B%22conditions%22%3A%7B%22languages%22%3A%5B%5D%2C%22status%22%3A%22%22%2C%22collection_ids%22%3A%5B%222243179%22%5D%7D%2C%22order%22%3A%7B%22direction%22%3A%22desc%22%2C%22key%22%3A%22updated_at%22%7D%7D)**
18
+
19
+
index.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:a95784d6de5b50827e4cdb9f819ecbecaf6d4b6bd3e1925ddf47adeb1a0938da
3
+ size 2445410
urls.txt ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ https://help.foodkit.io/en/articles/3868573-foodkit-core-platform-overview
2
+ https://help.foodkit.io/en/articles/3868574-analytics
3
+ https://help.foodkit.io/en/articles/3868575-loyalty-dashboard
4
+ https://help.foodkit.io/en/articles/3868577-outlets-overview
5
+ https://help.foodkit.io/en/articles/3868578-customers-overview
6
+ https://help.foodkit.io/en/articles/3868580-order-details
7
+ https://help.foodkit.io/en/articles/3868581-action-items
8
+ https://help.foodkit.io/en/articles/3868582-orders-overview
9
+ https://help.foodkit.io/en/articles/3868583-dashboard-page-overview
10
+ https://help.foodkit.io/en/articles/3868585-reports