From 7d5184c579ed946ac613c08e4fcd376d4e3537f2 Mon Sep 17 00:00:00 2001
From: Fab Huang <50105554+FabioMiguel2000@users.noreply.github.com>
Date: Sun, 21 Apr 2024 15:27:26 +0100
Subject: [PATCH 1/3] Update README.md
---
README.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/README.md b/README.md
index 45053e2d..722bfaaf 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
# Acme-Caf-Order-System
+
+
+[](https://opensource.org/licenses/Apache-2.0)
+
From 279d5656e9fa6577e5146cd407c72769e4787113 Mon Sep 17 00:00:00 2001
From: Fab Huang <50105554+FabioMiguel2000@users.noreply.github.com>
Date: Sun, 21 Apr 2024 15:38:05 +0100
Subject: [PATCH 2/3] Added licensing and authors to README.md
---
README.md | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 722bfaaf..cecae3a9 100644
--- a/README.md
+++ b/README.md
@@ -59,9 +59,9 @@ docker exec -it api npm run data:import
docker exec -it api npm run data:destroy
```
-#### Run Application
+#### Run Client Application & Terminal Application
-1. Head inside the app's project directory `/coffee-order-application`, and add the server's base URL to the `local.properties`, accordingly:
+1. Head inside the app's project directory `/coffee-order-application` or `/coffee-order-terminal`, and add the server's base URL to the `local.properties`, accordingly:
If you are using a physical device:
```bash
@@ -78,5 +78,19 @@ If you are running on an emulator you can keep with the default base URL:
apiBaseUrl=http://10.0.2.2:3000/api/
```
+## Authors
+```
+Adalberto Oliveira Filipe
+Bruno de Sena Pereira
+Fabio Huang
+Gabriel de Sousa Gomes
+Garcia Isaias Manuel
+```
+
+
+## License
+
+This project is licensed under the Apache License, Version 2.0.
+For the complete text of the Apache License, please refer to the .
From 991635c38832389f913818f9a2b6918a576ecc8a Mon Sep 17 00:00:00 2001
From: Fab Huang <50105554+FabioMiguel2000@users.noreply.github.com>
Date: Sun, 21 Apr 2024 17:07:10 +0100
Subject: [PATCH 3/3] Added Screens to README.md
---
README.md | 40 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 40 insertions(+)
diff --git a/README.md b/README.md
index cecae3a9..b6c904b3 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,8 @@
+## Overview
+
A cafeteria – the Acme Café – intends to implement a more efficient ordering and delivery system, supplying an Android app to its customers and incentivizing them to use it, through a loyalty campaign.
The idea is for the customers compose previously their orders in the app, choosing items from a menu and their quantities, and transmit them, together with possible vouchers and identification data, to a terminal inside the house. After that, the customers only need to collect the ordered items at the counter when they are ready.
@@ -15,6 +17,44 @@ The idea is for the customers compose previously their orders in the app, choosi
https://github.com/FabioMiguel2000/Acme-Caf-Order-System/assets/50105554/dc386684-2fd6-40fc-ac47-e690bd5ef79e
+## Screens
+### Customer Application
+| Login | Register | Home Menu |
+|-------|----------|-----------|
+|  |  | 
+
+| Hot Coffees | Cart Empty | Apply Coffee Voucher |
+|-------|----------|-----------|
+|  |  | 
+
+| Apply Discount Voucher | Cart Filled | Checkout |
+|-------|----------|-----------|
+|  |  | 
+
+| Order Successful | Profile | All Available Vouchers |
+|-------|----------|-----------|
+|  |  | 
+
+| All Receipts | Receipt Details | Receipt Details |
+|-------|----------|-----------|
+|  |  |  |
+
+
+
+### Cafetaria Application
+| QrCode Reader | Accept Order | Validate Order |
+|-------|----------|-----------|
+|  |  | 
+
+| Order Validated | All Orders | Order Detail |
+|-------|----------|-----------|
+|  |  | 
+
+
+## Implementation Diagram
+
+
+
## Installing the Software Dependencies
To prepare your computer for development you need to install [Docker Desktop](https://www.docker.com/products/docker-desktop/).